JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 11422
  • Score
    100M100P100Q125299F
  • License MIT

Your automated markdown maintainer!

Package Exports

  • automd

Readme

🤖 automd

npm version npm downloads

Your automated markdown maintainer!

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

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 3 => ###) - Note: Each export uses headingLevel+1.

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.