# Monero Docs

This repository contains source files of official Monero documentation hosted at [docs.getmonero.org](https://docs.getmonero.org).

## Structure

This repository uses [Jekyll](https://jekyllrb.com/) and [just-the-docs](https://just-the-docs.com/).

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](https://github.com/monero-project/monero-docs/discussions/new/choose) before making macro-level changes.

## License

The source files, documentation and assets are copyrighted under [BSD 3-Clause "New" or "Revised" License](LICENSE.md).