typedoc-plugin-nomnoml
A plugin for TypeDoc that generates graphs for nomnoml diagrams by @nomnoml annotation.
Installation
The plugin can then be installed using npm:
npm
npm install --save-dev typedoc-plugin-nomnoml
yarn
yarn add -D typedoc-plugin-nomnoml
Usage
Write tsdoc with @nomnoml
annotation
/** * Hoge is sample class for example of `typedoc-plugin-nomnoml`. * * @nomnoml Alice greet to Jone * [Pirate|eyeCount: Int|raid();pillage()| * [beard]--[parrot] * [beard]-:>[foul mouth] * ] * * [<abstract>Marauder]<:--[Pirate] * [Pirate]- 0..7[mischief] * [jollyness]->[Pirate] * [jollyness]->[rum] * [jollyness]->[singing] * [Pirate]-> *[rum|tastiness: Int|swig()] * [Pirate]->[singing] * [singing]<->[rum] * * [<start>st]->[<state>plunder] * [plunder]->[<choice>more loot] * [more loot]->[st] * [more loot] no ->[<end>e] * * [<actor>Sailor] - [<usecase>shiver me;timbers] */
Help
$ typedoc --plugin typedoc-plugin-nomnoml -hLoaded plugin typedoc-plugin-nomnomlUsage: typedoc --mode modules --out path/to/documentation path/to/sourcefiles TypeDoc options: ... -h, --help Print this message. ... --nomnomlVersion Nomnoml Plugin: Version of nomnoml. ... TypeScript options:See https://www.typescriptlang.org/docs/handbook/compiler-options.html
Contributors
Thanks goes to these wonderful people (emoji key):
Yuki Yamazaki 💻 ⚠️ 📖 |
Tommy 🤔 |
This project follows the all-contributors specification. Contributions of any kind welcome!
License
This software is released under the MIT License, see LICENSE.