Hosted at docs.getmonero.org
Find a file
2025-02-19 22:06:33 +00:00
.github ci: comment coolify url on each PR 2024-12-15 18:34:48 +00:00
docs addresses: add stagenet prefix and update links 2025-02-07 23:47:57 +00:00
images Deployed 91a9fab with MkDocs version: 0.17.2 2017-12-22 23:22:35 +01:00
overrides footer: add social links 2024-09-02 19:50:13 +00:00
po R&D: add indexes 2025-02-07 14:48:21 +00:00
weblate i18n/weblate/po4a skeleton/base 2024-08-11 23:28:36 +01:00
.gitignore add mnemonics section 2024-11-26 20:13:06 +03:00
.gitmodules cleanup 2024-08-01 20:46:46 +01:00
404.html Improvements/Updates 2024-08-02 20:36:08 +01:00
Dockerfile_coolify build: require hashes for pip 2025-02-07 13:51:12 +00:00
LICENSE LICENSE: add mkdocs + material licenses 2024-08-18 21:47:34 +01:00
main.py plugins: add macros 2024-09-20 12:13:14 +00:00
mkdocs.yml R&D: add indexes 2025-02-07 14:48:21 +00:00
README.md build: require hashes for pip 2025-02-07 13:51:12 +00:00
requirements.in Merge pull request from monero-project/dependabot/pip/master/babel-2.17.0 2025-02-19 22:06:33 +00:00
requirements.txt Merge pull request from monero-project/dependabot/pip/master/babel-2.17.0 2025-02-19 22:06:33 +00:00

Monero Docs

This repository contains the source files to Monero Community documentation hosted at docs.getmonero.org

About

Monero Docs intends to be a Knowledge Base and User Guide for interacting with Monero.

Contributing

Contributions are both encouraged and greatly appreciated.

To contribute content, fork this repo and make a pull request to the master branch including your changes.

  1. On GitHub, fork the monero-docs repo
  2. Clone your newly created repo. (Note: replace your-username with your GitHub username)

via ssh:

git clone git@github.com:your-username/monero-docs

via https:

git clone https://github.com/your-username/monero-docs
  1. Navigate to the repo and create a new topic branch
cd monero-docs
git checkout -b foobar
  1. After making modifications, commit and push your changes to your topic branch
  2. Open a PR against the monero-docs master branch

Run the documentation server locally

  • The build process for mkdocs utilizes Python
  • It is recommended to install python pip dependencies inside of a Virtual Environment (venv)

Note: You may need to first install python3-venv or the equivalent for your distribution

  1. Navigate to your monero-docs repo
  2. Create the python virtual environment
python3 -m venv .monero-docs-venv
source .monero-docs-venv/bin/activate
  1. Install mkdocs dependencies to the venv
pip install --require-hashes -r requirements.txt
  1. Run the documentation server locally
python3 -m mkdocs serve
  1. View your changes at http://localhost:8000

License

The documentation is provided under the MIT License.