iv-org/documentation
1
0
Fork 0
mirror of https://github.com/iv-org/documentation.git synced 2024-11-22 21:39:45 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Enhance the README

Browse Source
This commit is contained in:
TheFrenchGhosty 2023-04-04 17:04:58 +02:00 committed by GitHub
parent 618e0d5f48
commit a847e516b2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -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