Wondering what’s next for npm?Check out our public roadmap! »

    @asyncapi/markdown-template

    0.13.12 • Public • Published

    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

    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

    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

    💻

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

    Install

    npm i @asyncapi/markdown-template

    DownloadsWeekly Downloads

    1,747

    Version

    0.13.12

    License

    Apache-2.0

    Unpacked Size

    59.4 kB

    Total Files

    26

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar