Go to file
ethfoo 8473c0fed8 Feat: add release ci.yml 2023-07-05 11:16:30 +08:00
.github/workflows Feat: add release ci.yml 2023-07-05 11:16:30 +08:00
docs Update release.md (#167) 2023-07-05 10:22:28 +08:00
overrides upgrade material doc; add multi version (#166) 2023-07-05 10:14:32 +08:00
.gitignore Release v1.2 (#67) 2022-06-16 17:23:55 +08:00
README.md Feat: add node about using more images from dockerhub (#53) 2022-05-12 21:01:28 +08:00
mkdocs.yml upgrade material doc; add multi version (#166) 2023-07-05 10:14:32 +08:00
nav.yml Feat: update roadmap 2023 (#143) 2023-01-12 13:47:30 +08:00

README.md

Loggie documentation

This is the source file repository for Loggie documentation.

Run the website locally

The Loggie documentation website is built using mkdocs-material.

The official Docker image is a great way to get up and running in a few minutes, as it comes with all dependencies pre-installed.

docker pull squidfunk/mkdocs-material

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Point your browser to localhost:8000 and you should see the website.