cook-docs¶

A tool for automatically generating markdown documentation for cooklang recipes.

  TL;DR¶

  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

  Usage¶

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¶

Documentation can be found here.

  Contributing¶

See Contributing

  Code of Conduct¶

See Code of Conduct

  Inspiration¶

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

​​ ​ License¶

​​Apache License 2.0

​​ ​ Author¶

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