@asyncapi/markdown-template
@asyncapi/markdown-template
npm i @asyncapi/markdown-template
@asyncapi/markdown-template

@asyncapi/markdown-template

Markdown template for the AsyncAPI Generator

by asyncapi

1.2.1 (see all)License:Apache-2.0TypeScript:Not Found
npm i @asyncapi/markdown-template
Readme

Markdown template for the AsyncAPI Generator

All Contributors

Usage

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

Supported parameters

NameDescriptionRequiredDefaultAllowed valuesExample
frontMatterThe 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 slateNoNoneAny JSON or YAML formatted fileslate.yaml
outFilenameThe filename of the output file.Noasyncapi.mdAny with .md extensionindex.md
tocInclude a Table-of-Contents in the output markdown.Notruebooleanfalse
versionOverride the version of your application provided under info.version location in the specification file.NoVersion is taken from the specification file.Version is taken from the spec file.1.0.0

Development

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

Parameters for the template are defined in package.json.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Fran Méndez

💻 📖 👀 🤔 🚧 🐛 ⚠️

Lukasz Gornicki

💻 📖 👀 🚇 🚧 🐛 ⚠️

Ilya Buzlov

💻 🐛

Julian Rabe

💻

Maciej Urbańczyk

📖 💻 🚧 🐛 👀 ⚠️

Ludovic Dussart

💻

Mike Ralphson

💻

stuartforrest-infinity

🐛 💻

Dale Lane

💻 🤔

Michael Gerischer

💻 🐛 ⚠️

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

Downloads/wk

1.8K

GitHub Stars

13

LAST COMMIT

8mos ago

MAINTAINERS

3

CONTRIBUTORS

15

OPEN ISSUES

3

OPEN PRs

0
VersionTagPublished
1.2.1
latest
2mos ago
No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100
No reviews found
Be the first to rate