🤖 automd

Your automated markdown maintainer!

[!NOTE] This project is in the early stages and under development.

🦴 Used by

JSDocs Generator

Create a section in your README.md:

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

Make sure to have some utility exports in src/index.ts annotated with JSDocs.

Now invoke automd:

npx automd@latest

The declared section will be automatically updated!

## Utils

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

### `add(a, b)`

Adds two numbers together.

**Example:**
```js
add(1, 2); // 3
```

<!-- AUTOMD_END -->

[!NOTE] automd uses untyped and jiti loader for JSDocs parsing and TypeScript support .

Supported Args

src: Path to the source file. The default is ./src/index and can be omitted.
headingLevel: Nested level for markdown group headings (default is 2 => ##). Note: Each function uses headingLevel+1 for title in nested levels.
group: Only render function exportes anotated with @group name. By default there is no group filter. Value can be an string or array of strings.

Development

Clone this repository
Install the 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.