https://github.com/rvm/rvm-site
RVM website and documentation
https://github.com/rvm/rvm-site
Last synced: 5 months ago
JSON representation
RVM website and documentation
- Host: GitHub
- URL: https://github.com/rvm/rvm-site
- Owner: rvm
- Created: 2010-02-27T18:51:22.000Z (almost 16 years ago)
- Default Branch: master
- Last Pushed: 2023-08-10T16:34:32.000Z (over 2 years ago)
- Last Synced: 2025-02-24T23:58:57.510Z (11 months ago)
- Language: Haml
- Homepage: https://rvm.io
- Size: 4.73 MB
- Stars: 118
- Watchers: 22
- Forks: 157
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Support: Support/Colloquy/PlugIns/bash.js
Awesome Lists containing this project
README
# RVM site and documentation
You can see the documentation live online at .
## Quick corrections
For small changes like single wording fixes it is enough to use GitHub builtin editor,
navigate to https://github.com/rvm/rvm-site/tree/master/content, find the page to fix
and press the **Edit** button, try to give meaningful description so it is easier to
understand why this change is needed.
## Running site locally
If you're going to help you'll first need to get the site running locally. Start by
forking the repository and cloning the fork.
### Requirements
This site requires a few gems that can be found in `Gemfile`, including:
- [MIME::Types](https://github.com/halostatue/mime-types#readme)
- [Compass](http://compass-style.org/)
- [Nanoc](https://nanoc.ws/)
- [Rack](https://rack.github.io/)
- [Haml](http://haml.info/) ([Sass](http://sass-lang.com/) is bundled with this Gem)
To install requirements run
bundle install
### Run
If you would like to view the changes locally as you hack, use nanoc-guard:
# in window/tab 1
guard
# in window/tab 2
nanoc view
And then open http://localhost:3000
It's required to reload page after changing code.
Validating site links integrity with Nanoc:
rake test
## Thanks
Thanks for taking the time to work on the RVM documentation project!