https://github.com/takase1121/shigure

Create docs from files
https://github.com/takase1121/shigure

Last synced: 11 days ago
JSON representation

Create docs from files

• Host: GitHub
• URL: https://github.com/takase1121/shigure
• Owner: takase1121
• License: isc
• Created: 2021-04-09T13:27:41.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-17T01:21:13.000Z (5 months ago)
• Last Synced: 2024-11-26T12:16:32.785Z (2 months ago)
• Language: TypeScript
• Size: 1.15 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Shigure

Like JSDoc, but for bots.

Shigure acts as a pipeline with `Reader`s taking filename as input and outputs a `Command`. The command can be transformed before passing to a `Writer`.

## Install

```sh

npm i -D @shigure/core @shigure/cli

npm i -D @shigure/reader-jsdoc @shigure/writer-json # optional, install if needed

```

## Examples

```js

// config.js

const { JsdocReader } = require('@shigure/reader-jsdoc')

const { JsonWriter } = require('@shigure/writer-json')

module.exports = {

    include: ['commands/*.js'],

    exclude: [],

    pipeline: [new JsdocReader(), new JsonWriter('doc.json')]

}

```

```

shigure -c config.js

```

## Readers and Writers

Currently, [JSDoc Reader](https://github.com/takase1121/shigure/tree/master/packages/reader-jsdoc), [JSON Writer](https://github.com/takase1121/shigure/tree/master/packages/writer-json) and [handlebars Writer](https://github.com/takase1121/shigure/tree/master/packages/writer-handlebars) are available. handlebars is probably flexible enough for most use cases, so I'm not planning to add new Writers.