Xargon/Wiki
1
0
Fork 0
mirror of https://github.com/RetroDECK/Wiki.git synced 2024-11-21 21:35: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:21:22 +00:00 committed by GitHub
parent f473eedcd8
commit 937b3203d1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -12,3 +12,14 @@
Join the Discord and post in `💙-i-want-to-help` channel that you want to help out with the wiki.
You will then get access to the `🖋-wiki-maintainers`channel by one of the mods and you can discuss with your fellow contributors in that channel.
## How to submit articles?
You need to have git, gh and python installed.
1. Clone the wiki repo.
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.
4. Browse to `http://127.0.0.1:8000/` and you will have a local instance of the wiki running.
5. Submit and commit new wiki .md articles under the docs/ structure.
6. Talk to `🖋-wiki-maintainers` before creating new subfolders under /docs