1
0
mirror of https://github.com/ko-build/ko.git synced 2024-11-19 18:01:46 +02:00
ko-build/docs
2024-10-30 13:22:37 -04:00
..
advanced add incert section 2024-10-30 13:22:37 -04:00
custom website: update CNCF announcement (#920) 2023-01-04 16:15:57 -05:00
features docs: add draft for debugging 2024-06-11 12:23:21 -04:00
images feat(docs): Add dark theme 2024-10-16 13:20:06 -04:00
reference feat: add image user option 2024-10-24 09:58:21 -04:00
CNAME attempt to fix GH Pages publishing (#843) 2022-10-11 12:53:29 -04:00
community.md Update community.md (#1179) 2023-11-08 15:25:24 +00:00
configuration.md Refactor global values to be defaults 2024-05-21 11:29:50 -04:00
deployment.md Fix fly.io deployment docs 2024-02-27 11:59:38 -05:00
get-started.md doc: fix link to Installation page in Getting Started (#846) 2022-10-12 16:00:16 -04:00
index.md feat(docs): Add dark theme 2024-10-16 13:20:06 -04:00
install.md Update setup-ko action link in install.md 2024-03-13 08:49:00 -04:00
README.md Move docs to ko.build (#749) 2022-09-30 15:04:37 -04:00

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 mkdocs and mkdocs-material and run mkdocs serve, or
  • docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
    • on an M1 Mac, use ghcr.io/afritzler/mkdocs-material instead.

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.