routegy-docs

Public documentation for Routegy

Status

Active development

Usage

⇒  make help
stack-build                    Build stack images
stack-build-no-cache           Build stack images ignoring docker cache
stack-volume-clean             Clean node_modules volume
stack-up                       Run stack from latest built images
stack-down                     Bring down running stack
stack-rm                       Remove any active running stack containers
stack-shell                    Run interactive shell in stack service image
stack-test                     Run all tests for the project
clean                          Clean local compiled state.
shell                          Run shell environment capable of managing dependencies.
help                           Print Makefile usage.

Theme Development

If you're working on theme modifications, it's easiest to just use yarn link so you can view modifications on refresh.

$ cd routegy-vuepress-theme
$ yarn link
$ cd ../routegy-docs
$ yarn link vuepress-theme-routegy

Technology

• Vuepress

Inspiration

• Django documentation
• What nobody tells you about documentation

License

See LICENSE