Edit icon  Improve this page

Editing this site

Local Setup

Download the source for this site from github

For installation of Ruby x >= 2.2.7 and Jekyll, 3.0.0 and up doesn’t seem to work though

be in the project folder Follow instructions here up until it tells you about setting up files

probably run bundle install

then bundle exec jekyll build

finally builde exec jekyll serve

view at localhost:4000

If it’s just to the contents, a line like this ## Foo will show up in contents.
(markdown for <h2>)

But what if I want to add a link to one of the categories?

Edit _data/docs_nav.yml and add the permalink in the group. You can even make new categories.

what’s the header in the markdown?

title The <h1> title for top of the page

permalink where the url for the markdown is

redirects_from if you try to go to one of those links,
you go to permalink instead

menu_name if you see this, it changes the title in the side bar

position pagination

Do I have to restart the server to see changes?

Nope.

Tutorial label

Make sure it matches in all steps

I’d make it so as long as they’re in the same folder it all counts as one, but liquid’s filters are a pain,
who doesn’t offer () to alter order of operations for filters? liquid