https://github.com/baransu/elm-docs

📖 Markdown documentation generator for elm-make compatible projects
https://github.com/baransu/elm-docs

cli docs documentation elm elm-lang

Last synced: 5 days ago
JSON representation

📖 Markdown documentation generator for elm-make compatible projects

• Host: GitHub
• URL: https://github.com/baransu/elm-docs
• Owner: baransu
• License: mit
• Created: 2017-07-11T19:32:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-11-09T17:41:28.000Z (about 6 years ago)
• Last Synced: 2024-12-19T09:14:35.827Z (5 days ago)
• Topics: cli, docs, documentation, elm, elm-lang
• Language: JavaScript
• Homepage:
• Size: 15.6 KB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# elm-docs

> 📖 Markdown documentation generator for elm-make compatible projects

Example generated docs for [wende/elchemy](https://github.com/wende/elchemy): https://gist.github.com/Baransu/26ce8e7c987f68f078a8e415a2601d3c

## Usage

Install globally with you package manager of choice:

```sh

yarn global add elm-docs

# or

npm install -g elm-docs

```

Then go into root of your `elm-make` project and use

```sh

elm-docs

```

By default output will be placed in `DOCS.md` file in your current directory. To specify custom output file you can use `--output, -o` flag and define your file of choice like that:

```sh

elm-docs --output DOCUMENTATION.md 

```

It will output documentation into `DOCUMENTATION.md` file in you current directory.

## Licence

MIT © Tomasz Cichocinski