jekyll/docs
Tom Johnson 845580a258 Documentation on how to build navigation
I added a documentation page on how to build navigation for your site. This topic is primarily intended for users who have a lot of pages on their site (such as for documentation websites), and want to build a more robust sidebar navigation.

Jekyll combines Liquid with YAML in interesting ways that aren't really documented clearly in the existing docs, except for a brief reference [here](http://jekyllrb.com/docs/datafiles/#the-data-folder). You can read about Liquid on Shopify and YAML in YAML's docs, but exactly how you store YAML files in a Jekyll project and iterate through them using Liquid loops and filters to generate lists of pages is something that isn't clear to a lot of people. (You can see origins of these questions in [previous help issues](https://github.com/jekyll/jekyll-help/issues/266).)  The documentation on navigation would fit well into the Jekyll docs.
2016-12-26 23:15:22 -08:00
..
_data Move docs/development to docs/maintaining 2016-11-02 14:03:08 -07:00
_docs Documentation on how to build navigation 2016-12-26 23:15:22 -08:00
_includes Switch to `https` when possible. 2016-11-29 23:39:23 +02:00
_layouts Fix 'Improve this page' link. 2016-11-02 15:09:46 -07:00
_posts Switch to `https` when possible. 2016-11-29 23:39:23 +02:00
_sass Update _font-awesome.scss 2016-12-01 11:57:10 +02:00
community move site to docs folder 2016-11-02 13:51:14 -07:00
css move site to docs folder 2016-11-02 13:51:14 -07:00
fonts Use only the used Font Awesome icons. 2016-11-29 10:41:49 +02:00
help move site to docs folder 2016-11-02 13:51:14 -07:00
img move site to docs folder 2016-11-02 13:51:14 -07:00
js move site to docs folder 2016-11-02 13:51:14 -07:00
news move site to docs folder 2016-11-02 13:51:14 -07:00
redirects move site to docs folder 2016-11-02 13:51:14 -07:00
.gitignore move site to docs folder 2016-11-02 13:51:14 -07:00
404.html move site to docs folder 2016-11-02 13:51:14 -07:00
CNAME move site to docs folder 2016-11-02 13:51:14 -07:00
_config.yml Move posts-specific permalink into collections metadata. Way better. 💫 2016-11-02 14:12:03 -07:00
favicon.ico move site to docs folder 2016-11-02 13:51:14 -07:00
icomoon-selection.json Use only the used Font Awesome icons. 2016-11-29 10:41:49 +02:00
index.html move site to docs folder 2016-11-02 13:51:14 -07:00
latest_version.txt Release 💎 3.3.1 2016-11-14 14:36:05 -08:00
readme.md Merge pull request #5611 from XhmikosR/https 2016-11-29 15:50:29 -08:00

readme.md

Jekyll docs site

This directory contains the code for the Jekyll docs site, jekyllrb.com.

Contributing

For information about contributing, see the Contributing page.

Running locally

You can preview your contributions before opening a pull request by running from within the directory:

  1. bundle install --without test test_legacy benchmark
  2. bundle exec rake site:preview

It's just a jekyll site, afterall! 😉

Updating Font Awesome

  1. Go to https://icomoon.io/app/
  2. Choose Import Icons and load icomoon-selection.json
  3. Choose Generate Font → Download
  4. Copy the font files and adapt the CSS to the paths we use in Jekyll