dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #3601 from chrisfinazzo/update-collections-docs 

Merge pull request 3601
This commit is contained in:
Parker Moore 2015-03-21 17:03:47 -07:00
parent 27d3efecc1 a8b7a224c8
commit 88d9cf4816
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
site/_docs/collections.md
View File

@ -44,8 +44,13 @@ documents. YAML Front Matter is read in as data if it exists, and everything
after it is stuck in the Document's `content` attribute. If no YAML Front after it is stuck in the Document's `content` attribute. If no YAML Front
Matter is provided, Jekyll will not generate the file in your collection. Matter is provided, Jekyll will not generate the file in your collection.
Note: the folder must be named identically to the collection you defined in <div class="note info">
your `_config.yml` file, with the addition of the preceding `_` character. <h5>Be sure to name your directories correctly</h5>
<p>
The folder must be named identically to the collection you defined in
your <code>_config.yml</code> file, with the addition of the preceding <code>_</code> character.
</p>
</div>
### Step 3: Optionally render your collection's documents into independent files ### Step 3: Optionally render your collection's documents into independent files
@ -64,8 +69,8 @@ For example, if you have `_my_collection/some_subdir/some_doc.md`,
it will be rendered using Liquid and the Markdown converter of your it will be rendered using Liquid and the Markdown converter of your
choice and written out to `<dest>/my_collection/some_subdir/some_doc.html`. choice and written out to `<dest>/my_collection/some_subdir/some_doc.html`.
As for posts with [Permalinks](../permalinks/), document URL can be customized As for posts with [Permalinks](../permalinks/), the document
by setting a `permalink` metadata to the collection: URL can be customized by setting `permalink` metadata for the collection:
{% highlight yaml %} {% highlight yaml %}
collections: collections:
@ -77,9 +82,14 @@ collections:
For example, if you have `_my_collection/some_subdir/some_doc.md`, it will be For example, if you have `_my_collection/some_subdir/some_doc.md`, it will be
written out to `<dest>/awesome/some_subdir/some_doc/index.html`. written out to `<dest>/awesome/some_subdir/some_doc/index.html`.
**Note that files in collections that do not have front matter are treated <div class="note info">
<h5>Don't forget to add YAML for processing</h5>
<p>
Files in collections that do not have front matter are treated
as static files and simply copied to their output location without as static files and simply copied to their output location without
processing.** processing.
</p>
</div>
<div class="mobile-side-scroller"> <div class="mobile-side-scroller">
<table> <table>