This is the source for the thinreports.org/documentation generated by Jekyll on GitHub Pages.
Contributing to Thinreports Documentation
Report mistakes, post your suggestions
Edit the documents on browser
- Click the
Edit this pagebutton of each page
- Edit content and propose your change. Please see this page for more instructions
Edit the documents by Pull Request
- GitHub account
- Ruby 2.0+
- Bundler 1.6.0+
- Pygments (Windows excepted)
How to install Pygments
- Install Python
- Install Pygments using easy_install as follows:
$ sudo easy_install pygments
Fork this repository, and clone your forked repository:
$ git clone firstname.lastname@example.org:yourname/documentation.git
Create your feature or improvement branch:
$ git checkout -b new-feature
Install runtime dependencies:
$ bundle install
Launch Jekyll server with
$ bundle exec jekyll server -w -b ''
If your platform is Windows, launch it with
--config option as follows:
$ bundle exec jekyll server -w -b '' --config _config.yml,_extras/config.yml
Editing documents and confirmation
If you edit documents, it is automatically compiled by Jekyll.
You should open
http://localhost:4000 in your browser, and make sure your changes.
Commit and pull request
Push your changes to your forked repository:
$ git commit -am 'add some new feature' $ git push origin new-feature
Then, create new Pull Request! Thanks!