🤖 automd

Your automated markdown maintainer!

[!NOTE] This project is is erly trial stages!

JSDocs Generator

Create a section in your README.md:

# JSRand

Random number utils.

## Utils

<!-- AUTOMD_START generator="jsdocs" src="./index.ts" -->
<!-- AUTOMD_END -->

Make sure to have some utility exports in index.ts annotated with JSDocs. Example:

/**
 * Adds two numbers together.
 *
 * @example
 *
 * ```js
 * add(1, 2); // 3
 * ```
 */
export function add(a: number, b: number) {
  return a + b;
}

Now invokate automd update:

npx automd@latest update

The declarated automatically updated!

# JSRand

Random number utils.

## Utils

<!-- AUTOMD_START generator="jsdocs" src="./index.ts" -->

## `add(a, b)`

Adds two numbers together.

**Example:**

```js
add(1, 2); // 3
```


<!-- AUTOMD_END -->

Behind the scenes, we use untyped with a jiti based loader for TypeScript support.

Supported Args

• src: Path to the source file. Default is ./src/index a and can be omited

Development

• Clone this repository
• Install latest LTS version of Node.js
• Enable Corepack using corepack enable
• Install dependencies using pnpm install
• Run playground test using pnpm dev

License

Made with 💛

Published under MIT License.