A tool for automatically generating markdown documentation for cooklang recipes.
# brew
brew install nicholaswilde/tap/cook-docs
# scoop
scoop bucket add nicholaswilde https://github.com/nicholaswilde/scoop-bucket.git
scoop install nicholaswilde/cook-docs
⚠️ 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.
Documentation can be found here.
See Contributing
See Code of Conduct
Inspiration for this repository has been taken from helm-docs.
This project was started in 2022 by Nicholas Wilde.