Skip to content

Commit

Permalink
feat: rewrite template to the React engine (#43)
Browse files Browse the repository at this point in the history
  • Loading branch information
magicmatatjahu authored Dec 16, 2020
1 parent 775c2be commit a7589df
Show file tree
Hide file tree
Showing 25 changed files with 2,972 additions and 1,764 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules
test/output
output
output
__transpiled
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@

## Usage

```
```bash
ag asyncapi.yaml @asyncapi/markdown-template -o output
```

If you don't have the AsyncAPI Generator installed, you can install it like this:

```
```bash
npm install -g @asyncapi/generator
```

## Supported parameters

|Name|Description|Required|Default|Example|
Expand All @@ -23,9 +24,10 @@ npm install -g @asyncapi/generator
## Development

1. Make sure you have the latest generator installed `npm install -g @asyncapi/generator`.
1. Modify the template or it's helper functions. Adjust `test/spec/asyncapi.yml` to have more features if needed.
1. Generate output with watcher enables `npm run dev`.
1. Check generated markdown file located in `./test/output/asyncapi.md`.
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`.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Expand Down
28 changes: 0 additions & 28 deletions filters/all.js

This file was deleted.

10 changes: 0 additions & 10 deletions hooks/output-filename.js

This file was deleted.

Loading

0 comments on commit a7589df

Please sign in to comment.