mirror of
https://github.com/monero-project/monero-docs.git
synced 2025-01-03 01:19:56 +00:00
Hosted at docs.getmonero.org
assets | ||
docs/cryptography | ||
.gitignore | ||
404.html | ||
_config.yml | ||
about.markdown | ||
Gemfile | ||
Gemfile.lock | ||
index.markdown | ||
LICENSE.md | ||
README.md |
Monero Docs
This repository contains source files of official Monero documentation hosted at docs.getmonero.org.
Structure
This repository uses Jekyll and just-the-docs.
To build the project locally, you have to do the following steps:
- Install Ruby from your package manager
- Install Jekyll and Bundler:
gem install jekyll bundler
- Install dependencies:
bundle install
- Build and serve the project:
bundle exec jekyll serve
After all these, it should be running on port 4000 locally by default.
Changes
Changes and contributing is very welcomed in this repository. To contribute, fork and make a pull request to the master branch including your changes. Please ask the community or create a discussion before making macro-level changes.
License
The source files, documentation and assets are copyrighted under BSD 3-Clause "New" or "Revised" License.