Go to file
mmaxiaolei 04974e5e76 file source glob 2022-04-12 21:13:54 +08:00
.github/workflows Init 2021-08-25 20:28:03 +08:00
docs file source glob 2022-04-12 21:13:54 +08:00
overrides Docs: update quick start 2022-03-10 10:07:24 +08:00
README.md Docs: update user-guide 2022-03-08 20:15:41 +08:00
mkdocs.yml Feat: add github repo in header 2021-12-31 16:54:49 +08:00
nav.yml Docs: update user-guide 2022-03-08 20:15:41 +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 webside.