Markdown template for the AsyncAPI Generator
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
|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|
Development
- 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.
Contributors β¨
Thanks goes to these wonderful people (
emoji key):
<td align="center"><a href="http://www.fmvilas.com"><img src="https://avatars3.githubusercontent.com/u/242119?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Fran MΓ©ndez</b></sub></a><br /><a href="https://github.com/asyncapi/markdown-template/commits?author=fmvilas" title="Code">π»</a> <a href="https://github.com/asyncapi/markdown-template/commits?author=fmvilas" title="Documentation">π</a> <a href="https://github.com/asyncapi/markdown-template/pulls?q=is%3Apr+reviewed-by%3Afmvilas" title="Reviewed Pull Requests">π</a> <a href="#ideas-fmvilas" title="Ideas, Planning, & Feedback">π€</a> <a href="#maintenance-fmvilas" title="Maintenance">π§</a> <a href="https://github.com/asyncapi/markdown-template/issues?q=author%3Afmvilas" title="Bug reports">π</a> <a href="https://github.com/asyncapi/markdown-template/commits?author=fmvilas" title="Tests">β οΈ</a></td>
<td align="center"><a href="https://resume.github.io/?derberg"><img src="https://avatars1.githubusercontent.com/u/6995927?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Lukasz Gornicki</b></sub></a><br /><a href="https://github.com/asyncapi/markdown-template/commits?author=derberg" title="Code">π»</a> <a href="https://github.com/asyncapi/markdown-template/commits?author=derberg" title="Documentation">π</a> <a href="https://github.com/asyncapi/markdown-template/pulls?q=is%3Apr+reviewed-by%3Aderberg" title="Reviewed Pull Requests">π</a> <a href="#infra-derberg" title="Infrastructure (Hosting, Build-Tools, etc)">π</a> <a href="#maintenance-derberg" title="Maintenance">π§</a> <a href="https://github.com/asyncapi/markdown-template/issues?q=author%3Aderberg" title="Bug reports">π</a> <a href="https://github.com/asyncapi/markdown-template/commits?author=derberg" title="Tests">β οΈ</a></td>
<td align="center"><a href="https://github.com/ximyro"><img src="https://avatars0.githubusercontent.com/u/1026811?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ilya Buzlov</b></sub></a><br /><a href="https://github.com/asyncapi/markdown-template/commits?author=ximyro" title="Code">π»</a> <a href="https://github.com/asyncapi/markdown-template/issues?q=author%3Aximyro" title="Bug reports">π</a></td>
<td align="center"><a href="https://deltaeight.de"><img src="https://avatars1.githubusercontent.com/u/19175262?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Julian Rabe</b></sub></a><br /><a href="https://github.com/asyncapi/markdown-template/commits?author=schw4rzlicht" title="Code">π»</a></td>
<td align="center"><a href="https://github.com/magicmatatjahu"><img src="https://avatars2.githubusercontent.com/u/20404945?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Maciej UrbaΕczyk</b></sub></a><br /><a href="https://github.com/asyncapi/markdown-template/commits?author=magicmatatjahu" title="Documentation">π</a> <a href="https://github.com/asyncapi/markdown-template/commits?author=magicmatatjahu" title="Code">π»</a> <a href="#maintenance-magicmatatjahu" title="Maintenance">π§</a> <a href="https://github.com/asyncapi/markdown-template/issues?q=author%3Amagicmatatjahu" title="Bug reports">π</a> <a href="https://github.com/asyncapi/markdown-template/pulls?q=is%3Apr+reviewed-by%3Amagicmatatjahu" title="Reviewed Pull Requests">π</a> <a href="https://github.com/asyncapi/markdown-template/commits?author=magicmatatjahu" title="Tests">β οΈ</a></td>
<td align="center"><a href="http://blog.ineat-conseil.fr/"><img src="https://avatars.githubusercontent.com/u/5501911?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ludovic Dussart</b></sub></a><br /><a href="https://github.com/asyncapi/markdown-template/commits?author=M3lkior" title="Code">π»</a></td>
<td align="center"><a href="http://mermade.github.io"><img src="https://avatars.githubusercontent.com/u/21603?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mike Ralphson</b></sub></a><br /><a href="https://github.com/asyncapi/markdown-template/commits?author=MikeRalphson" title="Code">π»</a></td>
|
<td align="center"><a href="https://github.com/stuartforrest-infinity"><img src="https://avatars.githubusercontent.com/u/49638642?v=4?s=100" width="100px;" alt=""/><br /><sub><b>stuartforrest-infinity</b></sub></a><br /><a href="https://github.com/asyncapi/markdown-template/issues?q=author%3Astuartforrest-infinity" title="Bug reports">π</a> <a href="https://github.com/asyncapi/markdown-template/commits?author=stuartforrest-infinity" title="Code">π»</a></td>
<td align="center"><a href="http://dalelane.co.uk/"><img src="https://avatars.githubusercontent.com/u/1444788?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dale Lane</b></sub></a><br /><a href="https://github.com/asyncapi/markdown-template/commits?author=dalelane" title="Code">π»</a> <a href="#ideas-dalelane" title="Ideas, Planning, & Feedback">π€</a></td>
<td align="center"><a href="https://github.com/GerMichael"><img src="https://avatars.githubusercontent.com/u/62344871?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Michael Gerischer</b></sub></a><br /><a href="https://github.com/asyncapi/markdown-template/commits?author=GerMichael" title="Code">π»</a> <a href="https://github.com/asyncapi/markdown-template/issues?q=author%3AGerMichael" title="Bug reports">π</a> <a href="https://github.com/asyncapi/markdown-template/commits?author=GerMichael" title="Tests">β οΈ</a></td>
|
This project follows the
all-contributors specification. Contributions of any kind welcome!
