From a847e516b2eff661eb53552536c7230c0e9b0e80 Mon Sep 17 00:00:00 2001 From: TheFrenchGhosty <47571719+TheFrenchGhosty@users.noreply.github.com> Date: Tue, 4 Apr 2023 17:04:58 +0200 Subject: [PATCH] Enhance the README --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fcd9f73..e2f6d9c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # The Invidious documentation -# Running the documentation locally for development purposes +## Running the documentation locally for development purposes -## Local `mkdocs-material` installation +Run those commands in the repository's folder. + +### Local `mkdocs-material` installation ```bash # You might want to create a virtualenv first @@ -10,7 +12,7 @@ pip install mkdocs-material mkdocs-material serve ``` -## With docker +### With docker ```bash docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material:latest