https://github.com/kamiazya/typedoc-plugin-nomnoml

A plugin for TypeDoc that generates graphs for nomnoml diagrams by using @nomnoml annotation.
https://github.com/kamiazya/typedoc-plugin-nomnoml

diagram graph nomnoml nomnoml-preview typedoc typedocplugin

Last synced: 5 months ago
JSON representation

A plugin for TypeDoc that generates graphs for nomnoml diagrams by using @nomnoml annotation.

• Host: GitHub
• URL: https://github.com/kamiazya/typedoc-plugin-nomnoml
• Owner: kamiazya
• License: mit
• Created: 2019-10-09T14:30:43.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T04:22:32.000Z (over 3 years ago)
• Last Synced: 2025-11-27T12:04:26.245Z (7 months ago)
• Topics: diagram, graph, nomnoml, nomnoml-preview, typedoc, typedocplugin
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/typedoc-plugin-nomnoml
• Size: 332 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![GitHub Action](https://github.com/kamiazya/typedoc-plugin-nomnoml/workflows/Node%20CI/badge.svg)](https://github.com/kamiazya/typedoc-plugin-nomnoml/actions?workflow=Node+CI) [![npm version](https://badge.fury.io/js/typedoc-plugin-nomnoml.svg)](https://badge.fury.io/js/typedoc-plugin-nomnoml) [![Maintainability](https://api.codeclimate.com/v1/badges/330fef9d4d98238e09c1/maintainability)](https://codeclimate.com/github/kamiazya/typedoc-plugin-nomnoml/maintainability) [![BCH compliance](https://bettercodehub.com/edge/badge/kamiazya/typedoc-plugin-nomnoml?branch=master)](https://bettercodehub.com/) [![CodeFactor](https://www.codefactor.io/repository/github/kamiazya/typedoc-plugin-nomnoml/badge)](https://www.codefactor.io/repository/github/kamiazya/typedoc-plugin-nomnoml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier) 

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

# 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](https://www.npmjs.com/):

[![NPM](https://nodei.co/npm/typedoc-plugin-nomnoml.png)](https://nodei.co/npm/typedoc-plugin-nomnoml/)

### npm

```bash

npm install --save-dev typedoc-plugin-nomnoml

```

### yarn

```bash

yarn add -D typedoc-plugin-nomnoml

```

## Usage

Write tsdoc with `@nomnoml` annotation

```typescript

/**

 * 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]

 * ]

 *

 * [Marauder]<:--[Pirate]

 * [Pirate]- 0..7[mischief]

 * [jollyness]->[Pirate]

 * [jollyness]->[rum]

 * [jollyness]->[singing]

 * [Pirate]-> *[rum|tastiness: Int|swig()]

 * [Pirate]->[singing]

 * [singing]<->[rum]

 *

 * [st]->[plunder]

 * [plunder]->[more loot]

 * [more loot]->[st]

 * [more loot] no ->[e]

 *

 * [Sailor] - [shiver me;timbers]

 */

export class Hoge { }

```

### Help

```bash

$ typedoc --plugin typedoc-plugin-nomnoml -h

Loaded plugin typedoc-plugin-nomnoml

Usage:

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

  

    
Yuki Yamazaki
💻 ⚠️ 📖

    
Tommy
🤔

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors)

specification. Contributions of any kind welcome!

## License

This software is released under the MIT License, see [LICENSE](./LICENSE).