{"id":13510115,"url":"https://github.com/asyncapi/markdown-template","last_synced_at":"2025-06-17T07:40:33.917Z","repository":{"id":37906993,"uuid":"248818855","full_name":"asyncapi/markdown-template","owner":"asyncapi","description":"Markdown template for the AsyncAPI Generator","archived":false,"fork":false,"pushed_at":"2024-10-27T11:33:18.000Z","size":5767,"stargazers_count":26,"open_issues_count":3,"forks_count":34,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-29T22:38:04.548Z","etag":null,"topics":["asyncapi","generator","get-global-node-release-workflows","get-global-releaserc","hacktoberfest","markdown","nodejs","template"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/asyncapi.png","metadata":{"funding":{"github":"asyncapi","patreon":null,"open_collective":"asyncapi","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null},"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-20T17:52:20.000Z","updated_at":"2024-10-27T11:33:21.000Z","dependencies_parsed_at":"2023-12-15T22:05:35.344Z","dependency_job_id":"9a8fe932-abee-4b20-8378-c3371f50ac72","html_url":"https://github.com/asyncapi/markdown-template","commit_stats":{"total_commits":422,"total_committers":21,"mean_commits":"20.095238095238095","dds":"0.23933649289099523","last_synced_commit":"c32d9d324996d3c953800103fcde3e7418b3ebaf"},"previous_names":[],"tags_count":77,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asyncapi%2Fmarkdown-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asyncapi%2Fmarkdown-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asyncapi%2Fmarkdown-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asyncapi%2Fmarkdown-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asyncapi","download_url":"https://codeload.github.com/asyncapi/markdown-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246085655,"owners_count":20721213,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asyncapi","generator","get-global-node-release-workflows","get-global-releaserc","hacktoberfest","markdown","nodejs","template"],"created_at":"2024-08-01T02:01:24.631Z","updated_at":"2025-03-30T15:30:35.457Z","avatar_url":"https://github.com/asyncapi.png","language":"JavaScript","funding_links":["https://github.com/sponsors/asyncapi","https://opencollective.com/asyncapi"],"categories":["JavaScript","nodejs"],"sub_categories":[],"readme":"# Markdown template for the AsyncAPI Generator\n\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\n\u003c!-- toc is generated with GitHub Actions do not remove toc markers --\u003e\n\n\u003c!-- toc --\u003e\n\n- [Usage](#usage)\n- [Supported parameters](#supported-parameters)\n- [Development](#development)\n- [Contributors ✨](#contributors-%E2%9C%A8)\n\n\u003c!-- tocstop --\u003e\n\n## Usage\n\nInstall AsyncAPI CLI\n\n```bash\nnpm install -g @asyncapi/cli\n```\n\nGenerate using CLI \n\n```bash\nasyncapi generate fromTemplate \u003casyncapi.yaml\u003e @asyncapi/markdown-template@1.2.1\n```\n\nYou can replace `\u003casyncapi.yaml\u003e` with local path or URL pointing to [any AsyncAPI document](https://raw.githubusercontent.com/asyncapi/spec/master/examples/streetlights-kafka-asyncapi.yml).\nLook into [Releases](/asyncapi/markdown-template/releases) of this template to pick up the version you need. It is not recommended to always use the latest in production. Always use a specific version.\n\n## Supported parameters\n\n|Name|Description|Required|Default|Allowed values|Example|\n|---|---|---|---|---|---|\n|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](test/spec/ssg.yaml) 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](test/spec/slate.yaml) you can see an example that uses tags in frontmatter compatible with [slate](https://github.com/Slatedocs/Slate) |No|None|Any JSON or YAML formatted file|`slate.yaml`|\n|outFilename|The filename of the output file.|No|`asyncapi.md`|*Any* with `.md` extension|`index.md`|\n|toc|Include a Table-of-Contents in the output markdown.|No|`true`|`boolean`|`false`|\n|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`|\n\n\n## Development\n\n1. Make sure you have the latest generator installed `npm install -g @asyncapi/generator`.\n2. Modify the template or it's reusable parts. Adjust `test/spec/asyncapi.yml` to have more complexity if needed.\n3. Generate output with watcher enabled by running the command `npm run dev`.\n4. Check generated markdown file located in `./test/output/asyncapi.md`.\n\nParameters for the template are defined in `package.json`.\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://www.fmvilas.com\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/242119?v=4?s=100\" width=\"100px;\" alt=\"Fran Méndez\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eFran Méndez\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=fmvilas\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=fmvilas\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/pulls?q=is%3Apr+reviewed-by%3Afmvilas\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e \u003ca href=\"#ideas-fmvilas\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"#maintenance-fmvilas\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/issues?q=author%3Afmvilas\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=fmvilas\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://resume.github.io/?derberg\"\u003e\u003cimg src=\"https://avatars1.githubusercontent.com/u/6995927?v=4?s=100\" width=\"100px;\" alt=\"Lukasz Gornicki\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eLukasz Gornicki\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=derberg\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=derberg\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/pulls?q=is%3Apr+reviewed-by%3Aderberg\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e \u003ca href=\"#infra-derberg\" title=\"Infrastructure (Hosting, Build-Tools, etc)\"\u003e🚇\u003c/a\u003e \u003ca href=\"#maintenance-derberg\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/issues?q=author%3Aderberg\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=derberg\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/ximyro\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/1026811?v=4?s=100\" width=\"100px;\" alt=\"Ilya Buzlov\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eIlya Buzlov\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=ximyro\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/issues?q=author%3Aximyro\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://deltaeight.de\"\u003e\u003cimg src=\"https://avatars1.githubusercontent.com/u/19175262?v=4?s=100\" width=\"100px;\" alt=\"Julian Rabe\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eJulian Rabe\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=schw4rzlicht\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/magicmatatjahu\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/20404945?v=4?s=100\" width=\"100px;\" alt=\"Maciej Urbańczyk\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMaciej Urbańczyk\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=magicmatatjahu\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=magicmatatjahu\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#maintenance-magicmatatjahu\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/issues?q=author%3Amagicmatatjahu\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/pulls?q=is%3Apr+reviewed-by%3Amagicmatatjahu\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=magicmatatjahu\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://blog.ineat-conseil.fr/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/5501911?v=4?s=100\" width=\"100px;\" alt=\"Ludovic Dussart\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eLudovic Dussart\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=M3lkior\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://mermade.github.io\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/21603?v=4?s=100\" width=\"100px;\" alt=\"Mike Ralphson\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMike Ralphson\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=MikeRalphson\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/stuartforrest-infinity\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/49638642?v=4?s=100\" width=\"100px;\" alt=\"stuartforrest-infinity\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003estuartforrest-infinity\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/asyncapi/markdown-template/issues?q=author%3Astuartforrest-infinity\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=stuartforrest-infinity\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://dalelane.co.uk/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/1444788?v=4?s=100\" width=\"100px;\" alt=\"Dale Lane\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eDale Lane\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=dalelane\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#ideas-dalelane\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/GerMichael\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/62344871?v=4?s=100\" width=\"100px;\" alt=\"Michael Gerischer\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMichael Gerischer\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=GerMichael\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/issues?q=author%3AGerMichael\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=GerMichael\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/Arya-Gupta\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/84087089?v=4?s=100\" width=\"100px;\" alt=\"Arya Gupta\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eArya Gupta\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=Arya-Gupta\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/korifey91\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/40362351?v=4?s=100\" width=\"100px;\" alt=\"Kirill Efimov\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eKirill Efimov\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=korifey91\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/asyncapi/markdown-template/commits?author=korifey91\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasyncapi%2Fmarkdown-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasyncapi%2Fmarkdown-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasyncapi%2Fmarkdown-template/lists"}