5af2a529be
'--' is frequently used for command line options and was thus incorrectly rendered as a special en-dash symbol. |
||
|---|---|---|
| .. | ||
| _sass/color_schemes | ||
| _config.yml | ||
| adapting-existing.md | ||
| atomic-upgrades.md | ||
| buildsystem-and-repos.md | ||
| contributing-tutorial.md | ||
| CONTRIBUTING.md | ||
| deployment.md | ||
| formats.md | ||
| Gemfile | ||
| index.md | ||
| introduction.md | ||
| prep-docs.sh | ||
| README-historical.md | ||
| README.md | ||
| related-projects.md | ||
| repo.md | ||
| repository-management.md | ||
This documentation is written in Jekyll format to be published on GitHub Pages. The rendered HTML will be automatically built and published, but you can also use Jekyll locally to test changes.
First you need to install Ruby and
RubyGems to get Jekyll and the other gem
dependencies. This is easiest using the distro's packages. On RedHat
systems this is rubygems and on Debian systems this is
ruby-rubygems.
Next Bundler is needed to install the gems using
the provided Gemfile. You can do this by running gem install bundler or using distro packages. On RedHat systems this is
rubygem-bundler and on Debian systems this is ruby-bundler.
Now you can prepare the Jekyll environment. Change to this directory and run:
bundle config set --local path vendor/bundle
bundle install
Finally, run the prep-docs.sh script and then render and serve the
site locally with Jekyll:
./prep-docs.sh
bundle exec jekyll serve