Xargon/Wiki
1
0
Fork 0
mirror of https://github.com/RetroDECK/Wiki.git synced 2024-11-22 05:45:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Lazorne 2024-02-14 15:22:45 +00:00 committed by GitHub
parent 937b3203d1
commit 89b1d0707e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -19,7 +19,8 @@ You need to have git, gh and python installed.
1. Clone the wiki repo. 1. Clone the wiki repo.
2. Install `pip install mkdocs-material` & `pip install mkdocs-rss-plugin` 2. Install `pip install mkdocs-material` & `pip install mkdocs-rss-plugin`
3. In the `/wiki-rtd/` directory where the `mkdocs.yml` type from terminal `mkdocs serve` to start the local webserver. 3. Navigate to the `/wiki-rtd/` directory where the `mkdocs.yml` is located.
4. Browse to `http://127.0.0.1:8000/` and you will have a local instance of the wiki running. 4. Type in cli `mkdocs serve` to start the local webserver.
5. Submit and commit new wiki .md articles under the docs/ structure. 5. Browse to `http://127.0.0.1:8000/` and you will have a local instance of the wiki running.
6. Talk to `🖋-wiki-maintainers` before creating new subfolders under /docs 6. Submit and commit new wiki .md articles under the docs/ structure and wait for a wikimaintaners review to merge the commit.
7. Talk to `🖋-wiki-maintainers` before creating new subfolders under /docs