πŸ“š Documentation Generator for BuckleScript
Clone or download

README.md

bsdoc

Documentation Generator for BuckleScript projects.

Status: alpha.

Read more in the docs: BsDoc

Getting Started

# Go into your project
$ cd MyProject
MyProject $ yarn add bsdoc

# Create the support files
MyProject $ yarn run bsdoc support-files
yarn run v1.12.3
$ ./node_modules/.bin/bsdoc support-files
info: Copying support files (CSS, JS) into ./docs
info: Done βœ…
✨  Done in 0.53s.

# Build your docs!
MyProject $ yarn run bsdoc build MyProject
yarn run v1.12.3
$ ./node_modules/.bin/bsdoc build MyProject
info: Compiling documentation for package "MyProject"...
info: Generating .html files...
info: Done βœ…
✨  Done in 0.58s.