Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/asyncapi/markdown-template

Markdown template for the AsyncAPI Generator
https://github.com/asyncapi/markdown-template

asyncapi generator get-global-node-release-workflows get-global-releaserc hacktoberfest markdown nodejs template

Last synced: about 2 months ago
JSON representation

Markdown template for the AsyncAPI Generator

Host: GitHub
URL: https://github.com/asyncapi/markdown-template
Owner: asyncapi
Created: 2020-03-20T17:52:20.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-10-27T11:33:18.000Z (2 months ago)
Last Synced: 2024-10-29T22:38:04.548Z (about 2 months ago)
Topics: asyncapi, generator, get-global-node-release-workflows, get-global-releaserc, hacktoberfest, markdown, nodejs, template
Language: JavaScript
Homepage:
Size: 5.5 MB
Stars: 26
Watchers: 5
Forks: 34
Open Issues: 3
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        # Markdown template for the AsyncAPI Generator

[![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors-)

- [Usage](#usage)

- [Supported parameters](#supported-parameters)

- [Development](#development)

- [Contributors ✨](#contributors-%E2%9C%A8)

## Usage

Install AsyncAPI CLI

```bash

npm install -g @asyncapi/cli

```

Generate using CLI 

```bash

asyncapi generate fromTemplate  @asyncapi/[email protected]

```

You can replace `` with local path or URL pointing to [any AsyncAPI document](https://raw.githubusercontent.com/asyncapi/spec/master/examples/streetlights-kafka-asyncapi.yml).

Look 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.

## 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](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`|

|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](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
_{Fran Méndez}
💻 📖 👀 🤔 🚧 🐛 ⚠️

      
_{Lukasz Gornicki}
💻 📖 👀 🚇 🚧 🐛 ⚠️

      
_{Ilya Buzlov}
💻 🐛

      
_{Julian Rabe}
💻

      
_{Maciej Urbańczyk}
📖 💻 🚧 🐛 👀 ⚠️

      
_{Ludovic Dussart}
💻

      
_{Mike Ralphson}
💻

    

    

      
_{stuartforrest-infinity}
🐛 💻

      
_{Dale Lane}
💻 🤔

      
_{Michael Gerischer}
💻 🐛 ⚠️

      
_{Arya Gupta}
📖

      
_{Kirill Efimov}
💻 ⚠️

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!