cook-docs

A tool for automatically generating markdown documentation for cooklang recipes.

:rocket:  TL;DR

:floppy_disk:  Installation

# brew
brew install nicholaswilde/tap/cook-docs

# scoop
scoop bucket add nicholaswilde https://github.com/nicholaswilde/scoop-bucket.git
scoop install nicholaswilde/cook-docs

:gear:  Usage

:warning: Warning: The mode of operation of cook-docs is to process all recipes in the working directory and sub folders. See Mode of Operation for details.

cook-docs
# OR
cook-docs --dry-run # prints generated documentation to stdout rather than modifying markdown files.

:book:  Documentation

Documentation can be found here.

:star:  Contributing

See Contributing

:sparkles:  Code of Conduct

See Code of Conduct

:bulb:  Inspiration

Inspiration for this repository has been taken from helm-docs.

​:balance_scale:​ ​ License

​​Apache License 2.0

​:pencil:​ ​ Author

​This project was started in 2022 by ​Nicholas Wilde​.