Natural Potato Magnet


    1.2.0 • Public • Published

    Markdown template for the AsyncAPI Generator

    All Contributors


    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 Any with .md extension
    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


    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/

    Parameters for the template are defined in package.json.


    Thanks goes to these wonderful people (emoji key):

    Fran Méndez

    💻 📖 👀 🤔 🚧 🐛 ⚠️

    Lukasz Gornicki

    💻 📖 👀 🚇 🚧 🐛 ⚠️

    Ilya Buzlov

    💻 🐛

    Julian Rabe


    Maciej Urbańczyk

    📖 💻 🚧 🐛 👀 ⚠️

    Ludovic Dussart


    Mike Ralphson



    🐛 💻

    Dale Lane

    💻 🤔

    Michael Gerischer

    💻 🐛 ⚠️

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


    npm i @asyncapi/markdown-template

    DownloadsWeekly Downloads






    Unpacked Size

    260 kB

    Total Files


    Last publish


    • fmvilas
    • derberg
    • asyncapi-bot