diff --git a/docs/community/contribute.md b/docs/community/contribute.md index fb1ceb8..f76df09 100644 --- a/docs/community/contribute.md +++ b/docs/community/contribute.md @@ -59,7 +59,7 @@ The process is basically: 1. [Fork the repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) 2. Clone your forked repo locally 3. Make a new branch for your recipe (*not strictly necessary, but it helps to differentiate multiple in-flight recipes*) -4. Create your new recipe as a markdown file within the existing structure of the [docs folder](https://github.com/geek-cookbook/geek-cookbook/tree/main/docs) +4. Create your new recipe as a markdown file within the existing structure of the [docs folder](https://github.com/geek-cookbook/geek-cookbook/tree/main/docs) (see `docs/recipes/template.md` and `doc/recipes/kubernetes/template.md` for examples) 5. Add your recipe to the navigation by editing [mkdocs.yml](https://github.com/geek-cookbook/geek-cookbook/blob/main/mkdocs.yml#L32) 6. Test locally by running `./scripts/serve.sh` in the repo folder (*this launches a preview in Docker*), and navigating to 7. Rinse and repeat until you're ready to submit a PR diff --git a/scripts/serve-insiders.sh b/scripts/serve-insiders.sh index c123518..6ce72c4 100755 --- a/scripts/serve-insiders.sh +++ b/scripts/serve-insiders.sh @@ -1,4 +1,7 @@ #!/bin/bash # docker pull ghcr.io/geek-cookbook/mkdocs-material-insiders docker build --build-arg FROM_SOURCE=ghcr.io/geek-cookbook/mkdocs-material-insiders . -t funkypenguin/mkdocs-material -docker run --rm --name mkdocs-material -it -p 8123:8000 -v ${PWD}:/docs funkypenguin/mkdocs-material serve -f mkdocs-insiders.yml --dev-addr 0.0.0.0:8000 --dirtyreload +docker run --rm --name mkdocs-material -it -p 8123:8000 -v ${PWD}:/docs -e PROD_BUILD=false funkypenguin/mkdocs-material serve \ + --dev-addr 0.0.0.0:8000 \ + --dirtyreload \ + --config-file mkdocs-insiders.yml diff --git a/scripts/serve.sh b/scripts/serve.sh index 8fcf41d..8d4fb4d 100755 --- a/scripts/serve.sh +++ b/scripts/serve.sh @@ -1,7 +1,6 @@ #!/bin/bash -#docker pull squidfunk/mkdocs-material:latest -#docker build . -t funkypenguin/mkdocs-material +docker pull squidfunk/mkdocs-material:latest +docker build . -t funkypenguin/mkdocs-material docker run --rm --name mkdocs-material -it -p 8123:8000 -v ${PWD}:/docs -e PROD_BUILD=false funkypenguin/mkdocs-material serve \ --dev-addr 0.0.0.0:8000 \ - --dirtyreload \ - --config-file mkdocs-insiders.yml + --dirtyreload