mirror of
https://github.com/monero-project/monero-docs.git
synced 2024-12-22 11:39:35 +00:00
Hosted at docs.getmonero.org
plowsof
8f9d118def
- add default material theme config options - add privacy + tables plugin - add i18n plugin + locales - replace 404.html with template - add favicon - change repo/site links to monero-project/getmonero Co-authored-by: nahuhh <50635951+nahuhh@users.noreply.github.com> |
||
|---|---|---|
| assets | ||
| docs | ||
| images | ||
| mkdocs-material@ee2dba698e | ||
| search | ||
| .editorconfig | ||
| .gitignore | ||
| .gitmodules | ||
| 404.html | ||
| LICENSE | ||
| mkdocs.yml | ||
| README.md | ||
MoneroDocs
About
Monerodocs attempts to organize basic technical knowledge on Monero in one place.
While technical explanations are out there, knowledge is scattered through reddit posts, git comments, stack exchange answers, chat logs and the source code. This makes it hard to find complete and up-to-date explanations on advanced topics.
The goal is to educate and onboard power users faster.
Contributing
To contribute to MoneroDocs, you'll need to setup your local Mkdocs-Material environment:
# Fork the monerodocs/md Github repo
# Clone your newly created repo- be sure to include the submodule flag
git clone --recurse-submodules git@github.com:your-user-name/md.git
cd md
# Install mkdocs dependencies
pip install mkdocs-material mkdocs-minify-plugin
# Run the documentation server locally
python3 -m mkdocs serve