https://github.com/kevinlebrun/documentalist

A little tool to generate and serve documentation.
https://github.com/kevinlebrun/documentalist

documentation generator gitlab go golang server webhook

Last synced: 5 months ago
JSON representation

A little tool to generate and serve documentation.

• Host: GitHub
• URL: https://github.com/kevinlebrun/documentalist
• Owner: kevinlebrun
• License: mit
• Created: 2017-04-17T20:00:03.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-11-16T23:15:20.000Z (about 8 years ago)
• Last Synced: 2025-04-14T16:55:55.261Z (10 months ago)
• Topics: documentation, generator, gitlab, go, golang, server, webhook
• Language: Go
• Size: 307 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Documentalist

I use this little bot to generate and serve the documentation of my projects.

The bot need a configuration file at the project root named `.documentalist.json` with the following content:

```json

{

    "command": ["make", "doc"],

    "path": "build/doc",

    "notify": true

}

```

## Usage

```

$ go build .

$ ./documentalist -h

```

## License

(The MIT License)