From 7fd4b15814524e4204959fcfbaf1d9faed6e4bfe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20B=C4=85czek?= Date: Sun, 27 Nov 2022 20:09:49 +0100 Subject: [PATCH] Add README instructions for serving the docs locally (#287) * Add README instructions for serving the docs locally * Rename readme.md to README.md * Add a title Co-authored-by: TheFrenchGhosty <47571719+TheFrenchGhosty@users.noreply.github.com> --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fcd9f73 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# The Invidious documentation + +# Running the documentation locally for development purposes + +## Local `mkdocs-material` installation + +```bash +# You might want to create a virtualenv first +pip install mkdocs-material +mkdocs-material serve +``` + +## With docker + +```bash +docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material:latest +```