Hosted at docs.getmonero.org
Find a file
Piotr Włodarek 4cc3841548
Merge pull request #36 from CryptoGrampy/master
Fix submodules and add basic MoneroDocs setup guide
2021-11-15 08:10:05 +00:00
assets Deployed 1d553a8 with MkDocs version: 0.17.2 2017-12-23 02:35:59 +01:00
docs Merge pull request #34 from boldsuck/master 2021-11-10 10:43:33 +00:00
images Deployed 91a9fab with MkDocs version: 0.17.2 2017-12-22 23:22:35 +01:00
mkdocs-material@9dd23f6926 Re-add mkdocs-material as git submodule with .gitmodules 2021-11-14 17:06:35 -06:00
search Deployed 1d553a8 with MkDocs version: 0.17.2 2017-12-23 02:35:59 +01:00
.editorconfig Add monero-blockchain-export reference 2018-11-02 13:41:32 +01:00
.gitignore Add public directory to .gitignore 2021-11-15 08:47:02 +01:00
.gitmodules Re-add mkdocs-material as git submodule with .gitmodules 2021-11-14 17:06:35 -06:00
404.html Deployed 2df4c4c with MkDocs version: 0.17.2 2017-12-23 02:39:20 +01:00
LICENSE Add running-node/open-remote-node-tor-onion 2021-01-15 12:09:51 +01:00
mkdocs.yml Add a warning to "offline signing" plus cosmetic changes 2021-04-25 19:54:59 +02:00
README.md Add README.md with MoneroDocs local setup guide 2021-11-14 17:17:16 -06:00

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