I didn't know the difference between cgi_escape and uri_escape until it bit me when I had a colon in a title I used uri_escape on. Addressable::URI.encode (from addressable 2.4.0 and later) thought it was a URI and raised an error. I should have been using cgi_escape, which is for strings that will be added to URIs and not uri_escape, which is for encoding strings that are already in a URI.
This commit borrows from the addressable docs to make it more specific so that readers choose uri_escape when they already have a URI and cgi_escape when they are just escaping a plain string.
I moved the section about liquid and yaml to the end and shortened it. i also clarified that isn't an order-of-interpretation issue why liquid doesn't render in yaml. I also fixed the type with HMTL.
This tutorial defines Jekyll's "order of interpretation," as @swizca called it in [#5808](https://github.com/jekyll/jekyll/pull/5698). This tutorial makes it clear how Jekyll processes files as it renders the static HTML output.
This order-of-interpretation info is important for troubleshooting and generally understanding Jekyll. It's important to know how Jekyll generates out the files, what rules it uses, what order it processes things, and so forth.
(Note: Please process 5698 before this request, because 5698 includes the tutorial collection/navigation that this tutorial fits into. I also need to update this commit to add a link in the Tutorials nav to this topic, but I'm waiting for 5698 to be merged so that menu becomes available.)
@jekyll/documentation
@dirtyf
* master: (39 commits)
Update history to reflect merge of #5798 [ci skip]
Update history to reflect merge of #5822 [ci skip]
use logger.info
run codeclimate after success
Update history to reflect merge of #5819 [ci skip]
Fixed inaccuracy in "Built-in permalink styles" docs [skip ci]
Update history to reflect merge of #5802 [ci skip]
Update history to reflect merge of #5811 [ci skip]
Update history to reflect merge of #5690 [ci skip]
Update history to reflect merge of #5815 [ci skip]
Review CI pages
Rework CI doc to include multiple providers.
Update history to reflect merge of #5812 [ci skip]
Add jekyll-ga plug-in
Update configuration.md
Add mention of classifier-reborn for LSI
Update history to reflect merge of #5810 [ci skip]
Got that diaper money?
Added note about --blank flag
Update history to reflect merge of #5797 [ci skip]
...
When viewing a page, it's kind of hard to see what page you're viewing. The little triangle graphic pointing to the page is too subtle. Making the link to the current page orange (the same as the hover color) would make it visually more apparent where you are in the navigation. Here's a screenshot showing the change: [https://www.screencast.com/t/e6NKerSAUL](https://www.screencast.com/t/e6NKerSAUL). The link to the current page is orange even when I'm not hovering over the link with my mouse.
Must be either:
> Rather than typing `permalink: /:categories/:year/:month/:day/:title/`, you can just type `permalink: pretty`.
or:
> Rather than typing `permalink: /:categories/:year/:month/:day/:title.html`, you can just type `permalink: date`.
I guess the former was meant to write because the latter was already mentioned in "Where to configure permalinks" section.
1. Addition of *Running Jekyll on Ubuntu* section, to address Ubuntu stumbling block as per https://github.com/jekyll/jekyll/issues/5719.
2. Restructuring, and I hope I understood correctly when NodeJS/Python are/aren't required.
3. Gentler wording – it's probably not a good idea to tell punters who hit this page because they ran into trouble that installing Jekyll *is* easy and straight-forward; it *ought to be* straight-forward. (There's always the potential for pain and confusion if not all dependencies are in place.)
It turns out Liquid throws an error when you write `{% if {{ include.url }} %}` instead of `{% if {{include.url}} %}`. I updated the examples here to omit the spacing. To avoid inconsistency, I just omitted the spacing from all curly braces. Also added a note explaining the issue and put the blame on Liquid.
- made updates from Parkr's review
- update to Extensionless permalinks section
- update to note about not using built-in perm styles in front matter
- update for readability in places
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.
I created more advanced details about includes and created a new page for it instead of putting all the info on the templates page.
See https://github.com/jekyll/jekyll/pull/5630 for more details on the update.
@jekyll/documentation
@DirtyF
Prior to the change backticks were used in an attempt to create a
code block. The problem is that inside block level HTML tags Markdown
is not supported. I have replaced the backticks with a combination of
HTML tags in order to approximately simulate the appearance of a code
block. The docs suggest possible use of span tags in place of the
surrounding div tags as a solution to getting the Markdown to render.
I tried this but no success.
This change improves the readers understanding of the information,
because the reader doesn't have to make sense of raw markdown.
In case of the GitHub example links like `<a href="https://github.com/{{ org.username }}">` with the full URL plus the variable were used, but for the Twitter example link only the `{{ author.name }}` was set as `href`.
Phil Nash
jekyllbot
Ivan Storck
Ricardo N Feliciano
BlueberryFoxtrot
Marcelo Canina
Tom Johnson
Colin
Nate
Frank Taillandier
Parker Moore
Tom Johnson
Alexey Rogachev
penny
Josh Habdas
Nicolas Hoizey
Ajay Karwal
Tunghsiao Liu
Dmitrii Evdokimov
Purplecarrot
Max Chadwick
yoostk
Zlatan Vasović
Kurt Anderson
Longwelwind
muratayusuke
Skylar Challand
Rob Crocombe
Nursen
Ashwin Maroli
Ivan Dmitrievsky
Fabrice Laporte
kimbaudi
XhmikosR
Tim Banks
alexmalik
brainscript