@mf250324/markdown-template NPM

Markdown template for the AsyncAPI Generator

ag asyncapi.yaml @asyncapi/markdown-template -o output

If you don't have the AsyncAPI Generator installed, you can install it like this:

npm install -g @asyncapi/generator

Name	Description	Required	Default	Allowed values	Example
frontMatter	The name of a JSON or YAML formatted file containing values to provide the YAML frontmatter for static-site or documentation generators, just like this one. The file may contain {{title}} and {{version}} tags. They are replaced with information for the AsyncAPI document that is under `info.title` and `info.version`. You can overwrite the version with `version` parameter. Here you can see an example that uses tags in frontmatter compatible with slate	No	None	Any JSON or YAML formatted file	`slate.yaml`
outFilename	The filename of the output file.	No	`asyncapi.md`	Any with `.md` extension	`index.md`
toc	Include a Table-of-Contents in the output markdown.	No	`true`	`boolean`	`false`
version	Override the version of your application provided under `info.version` location in the specification file.	No	Version is taken from the specification file.	Version is taken from the spec file.	`1.0.0`

Make sure you have the latest generator installed npm install -g @asyncapi/generator.
Modify the template or it's reusable parts. Adjust test/spec/asyncapi.yml to have more complexity if needed.
Generate output with watcher enabled by running the command npm run dev.
Check generated markdown file located in ./test/output/asyncapi.md.

Parameters for the template are defined in package.json.

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

3 years ago