mirror of
https://github.com/ko-build/ko.git
synced 2025-11-23 22:35:11 +02:00
When trying out these examples, it is easier to have a deployment that can be copied and quickly tested. I don't think it adds too much clutter and it definitely saves people to troubleshoot why what they copied from the site doesn't work.
Docs for https://ko.build
Development
Update .md files to update content.
Update mkdocs.yml to update sidebar headers and ordering.
To run locally:
- install
mkdocsandmkdocs-materialand runmkdocs serve, or docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material- on an M1 Mac, use
ghcr.io/afritzler/mkdocs-materialinstead.
- on an M1 Mac, use
This will start a local server on localhost:8000 that autoupdates as you make changes.
Deployment
When PRs are merged, the site will be rebuilt and published automatically.
Credits
The site is powered by mkdocs-material. The code and theme are released under the MIT license.
Content is licensed CC-BY.