https://github.com/maproulette/docs
A documentation site for learning MapRoulette.
https://github.com/maproulette/docs
Last synced: 2 months ago
JSON representation
A documentation site for learning MapRoulette.
- Host: GitHub
- URL: https://github.com/maproulette/docs
- Owner: maproulette
- License: mit
- Created: 2020-08-10T20:54:01.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T21:56:03.000Z (3 months ago)
- Last Synced: 2025-04-24T22:49:13.509Z (2 months ago)
- Language: SCSS
- Homepage: https://learn.maproulette.org
- Size: 61.7 MB
- Stars: 5
- Watchers: 4
- Forks: 7
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# MapRoulette Docs
Documentation site for MapRoulette.org
If you would like to contribute to this documentation, thank you!
* If you want to fix a typo, update something that's out-of-date, or add a page or section on a new topic, please feel free to open a PR. Though if you want to add a new page or make large changes to existing content, you should probably open an issue first to gather feedback on your proposed changes.
* If you'd like to help translate existing documentation into other languages, have a look at our [guide on how to contribute translations](https://learn.maproulette.org/en-US/documentation/translate-docs/).
* If you have a video or article we should link to, feel free to open an issue and we will look at the best way to include it.
## Technical Details
This site is built using [Jekyll](https://jekyllrb.com/).
To build the website and preview it locally, you'll need to:
1. Install a recent Ruby version (tested on Ruby 3.4.1)
2. Run `gem install bundler` to install Bundler (a dependency manager for Ruby)
3. Run `bundle install` to install Jekyll and a few other dependencies (listed in the Gemfile)
4. Run `bundle exec jekyll serve` to build and start the website.
5. Go to http://localhost:4000 in your browser to view the site.
After this, if you add or make edits to markdown files, HTML templates, etc, Jekyll will rebuild the site automatically, and you'll see the changes once you refresh the page in your browser. If you make changes to `_config.yaml` or any code in the `_plugins` directory, you'll need to restart Jekyll for the changes to take effect.