mirror of
https://github.com/TextureGroup/Texture.git
synced 2026-04-07 19:17:39 +00:00
Huy Nguyen
0568a537d9
Our pages are organized in 2 dirs: /docs/ and /development/. Within a dir, prevPage and nextPage are relative (to the dir) so its path should be appended to their href links (see docs/_layouts/docs.html). The dir is available in the page's permalink var. Some prevPage and nextPage point to a page in a different dir in which case they must not be relative. Instead they must include the other dir's path and thus their links won't be modified. Also removed some pages that are no longer needed and fixed some prevPage and nextPage values. I tested this diff locally and all links worked fine.
Texture Documentation
We use Jekyll to build the site using Markdown and host it on Github Pages.
Dependencies
Github Pages uses Jekyll to host a site and Jekyll has the following dependencies.
Mac OS X comes pre-installed with Ruby, but you may need to update RubyGems (via gem update --system).
Once you have RubyGems, use it to install bundler.
$ gem install bundler
$ cd gh-pages # Go to folder
$ bundle install # Might need sudo.
Run Jekyll Locally
Use Jekyll to serve the website locally (by default, at http://localhost:4000):
$ bundle exec jekyll serve [--incremental]
$ open http://localhost:4000/
For more, see https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/