Improve template docs #5694

Merged
merged 4 commits into from Jan 18, 2017

Conversation

Projects
None yet
5 participants
@tomjoht
Contributor

tomjoht commented Dec 26, 2016

See #5630 for more details on the update.

@jekyll/documentation

Improve template docs
See #5630 for more details on the update. 

@jekyll/documentation
@DirtyF
docs/_docs/templates.md
@@ -421,56 +421,15 @@ The default is `default`. They are as follows (with what they filter):
### Includes
-If you have small page fragments that you wish to include in multiple places on
-your site, you can use the `include` tag.
+If you have small page fragments that you want to include in multiple places on your site, you can use the `include` tag:

This comment has been minimized.

@ashmaroli

ashmaroli Dec 26, 2016

Member
- If you have small page fragments that you want to include in multiple places on your site, you can use the `include` tag:
+ If you have small page snippets that you want to include in multiple places on your site, save the snippet as an *include file* and insert them where required, by using the `include` tag:
@ashmaroli

ashmaroli Dec 26, 2016

Member
- If you have small page fragments that you want to include in multiple places on your site, you can use the `include` tag:
+ If you have small page snippets that you want to include in multiple places on your site, save the snippet as an *include file* and insert them where required, by using the `include` tag:

This comment has been minimized.

@tomjoht

tomjoht Dec 27, 2016

Contributor

updated

@tomjoht

tomjoht Dec 27, 2016

Contributor

updated

docs/_docs/templates.md
-Jekyll expects all include files to be placed in an `_includes` directory at the
-root of your source directory. This will embed the contents of
-`<source>/_includes/footer.html` into the calling file.
+Jekyll expects all include files to be placed in an `_includes` directory at the root of your source directory. In the above example, this will embed the contents of `_includes/footer.html` into the calling file.

This comment has been minimized.

@ashmaroli

ashmaroli Dec 26, 2016

Member
- all include files
+ all *include files*
@ashmaroli

ashmaroli Dec 26, 2016

Member
- all include files
+ all *include files*

This comment has been minimized.

@tomjoht

tomjoht Dec 27, 2016

Contributor

updated, though i'm not sure why we're bolding it. is the bold formatting just to set off the term "include files" so that users don't think we're using "include" as a verb? if so, makes sense.

@tomjoht

tomjoht Dec 27, 2016

Contributor

updated, though i'm not sure why we're bolding it. is the bold formatting just to set off the term "include files" so that users don't think we're using "include" as a verb? if so, makes sense.

This comment has been minimized.

@ashmaroli

ashmaroli Dec 27, 2016

Member

so that users don't think we're using "include" as a verb?

yes, that's the intention.. and btw, its not bolding.. but italicizing. Bold is by double asterices.

@ashmaroli

ashmaroli Dec 27, 2016

Member

so that users don't think we're using "include" as a verb?

yes, that's the intention.. and btw, its not bolding.. but italicizing. Bold is by double asterices.

docs/_docs/templates.md
@@ -558,19 +539,29 @@ You can also use this tag to create a link in Markdown as follows:
{% endraw %}
```
-### Post URL
+Including `{% raw %}{{site.baseurl}}{% endraw %}` is optional &mdash; it depends on whether you want the link to be absolute or root-relative.

This comment has been minimized.

@ashmaroli

ashmaroli Dec 26, 2016

Member

This statement is wrong.
Inserting {{ site.baseurl }} doesn't make the URL absolute, its made so by: {{ site.url }}/{{ site.baseurl }}
Jekyll 3.3 ships with a new set of filters to address this confusion. Simply use {{ "file" | relative_url }} or {{ "file" | absolute_url }}

@ashmaroli

ashmaroli Dec 26, 2016

Member

This statement is wrong.
Inserting {{ site.baseurl }} doesn't make the URL absolute, its made so by: {{ site.url }}/{{ site.baseurl }}
Jekyll 3.3 ships with a new set of filters to address this confusion. Simply use {{ "file" | relative_url }} or {{ "file" | absolute_url }}

This comment has been minimized.

@tomjoht

tomjoht Dec 27, 2016

Contributor

updated

@tomjoht

tomjoht Dec 27, 2016

Contributor

updated

made requested updates
I made the requested updates. Mostly just small formatting improvements.
@tomjoht

This comment has been minimized.

Show comment
Hide comment
@tomjoht

tomjoht Dec 27, 2016

Contributor

I made the requested updates on this file. Submitting for re-review.

Contributor

tomjoht commented Dec 27, 2016

I made the requested updates on this file. Submitting for re-review.

docs/_docs/templates.md
-Jekyll expects all include files to be placed in an `_includes` directory at the
-root of your source directory. This will embed the contents of
-`<source>/_includes/footer.html` into the calling file.
+Jekyll expects all **include files** to be placed in an `_includes` directory at the root of your source directory. In the above example, this will embed the contents of `_includes/footer.html` into the calling file.

This comment has been minimized.

@ashmaroli

ashmaroli Dec 27, 2016

Member
- **include files**
+ *include files*
@ashmaroli

ashmaroli Dec 27, 2016

Member
- **include files**
+ *include files*

This comment has been minimized.

@tomjoht

tomjoht Dec 29, 2016

Contributor

fixed

@tomjoht

tomjoht Dec 29, 2016

Contributor

fixed

tomjoht and others added some commits Dec 29, 2016

made requested change
**includes** --> *includes*
@DirtyF

DirtyF approved these changes Jan 8, 2017

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Jan 9, 2017

Member

Now that we have #5696, will this have to change at all?

Member

parkr commented Jan 9, 2017

Now that we have #5696, will this have to change at all?

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Jan 9, 2017

Member

@parkr both PR are complementary, right now we got duplicate content concerning includes until this PR is merged.

Member

DirtyF commented Jan 9, 2017

@parkr both PR are complementary, right now we got duplicate content concerning includes until this PR is merged.

@tomjoht

This comment has been minimized.

Show comment
Hide comment
@tomjoht

tomjoht Jan 15, 2017

Contributor

Is there any reason why this PR hasn't been merged yet?

Contributor

tomjoht commented Jan 15, 2017

Is there any reason why this PR hasn't been merged yet?

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Jan 15, 2017

Member

@tomjohnson1492 No, it's just that this needs a second approval before merging.

Member

DirtyF commented Jan 15, 2017

@tomjohnson1492 No, it's just that this needs a second approval before merging.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Jan 18, 2017

Member

@jekyllbot: merge +site

Member

parkr commented Jan 18, 2017

@jekyllbot: merge +site

@jekyllbot jekyllbot merged commit 036d447 into jekyll:master Jan 18, 2017

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

jekyllbot added a commit that referenced this pull request Jan 18, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment