diff options
| author | omniscient <17525998+omnisci3nce@users.noreply.github.com> | 2024-05-12 19:21:52 +1000 |
|---|---|---|
| committer | omniscient <17525998+omnisci3nce@users.noreply.github.com> | 2024-05-12 19:21:52 +1000 |
| commit | e248c07d4dc894a00d0be3b572fba80db700a91f (patch) | |
| tree | ff7bf1064b5088be5d556044bd55dddc20f3bcee /README.md | |
| parent | b738432c3259fa6ddb6184e9608894618a3cb0ee (diff) | |
docker commands for mkdocs
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 9 |
1 files changed, 8 insertions, 1 deletions
@@ -20,4 +20,11 @@ All third-party dependencies are licensed under their own license. * `xmake format` * Lint (no change) `find src/ -iname *.h -o -iname *.c | xargs clang-format --style=file --dry-run --Werror` * Format (edit in place) `find src/ \( -iname "*.h" -o -iname "*.c" \) | xargs clang-format -i --style=file` - * `clang-format` must be installed!
\ No newline at end of file + * `clang-format` must be installed! + +* Documentation + * serve mkdocs locally + * `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material` + + * Build docs static site + * `docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build`
\ No newline at end of file |