Move gh-pages branch files into /docs and add test files
- Jekyll ignore `/docs` and `/test` folders when using from root
- Update Staticman config to point to correct branch and data file location
- Replace `{{ base_path }}` references with `absolute_url` filter
- Update documentation
This commit is contained in:
46
docs/_docs/13-collections.md
Normal file
46
docs/_docs/13-collections.md
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: "Working with Collections"
|
||||
permalink: /docs/collections/
|
||||
excerpt: "Suggestions and Front Matter defaults for working with collections."
|
||||
modified: 2016-11-03T11:13:38-04:00
|
||||
---
|
||||
|
||||
Collections like posts and pages work as you'd expect. If you're new to them be sure to read [Jekyll's documentation](https://jekyllrb.com/docs/collections/).
|
||||
|
||||
The theme has been built with collections in mind and you will find [several examples]({{ "/collection-archive/" | absolute_url }}) on the demo site ([portfolio]({{ "/portfolio/" | absolute_url }}), [recipes]({{ "/recipes/" | absolute_url }}), pets).
|
||||
|
||||
**Collections in the Wild:** This set of documentation is also [built as a collection](https://github.com/{{ site.repository }}/blob/master/docs/_docs/) if you're looking for a fully fleshed out example to inspect.
|
||||
{: .notice--info}
|
||||
|
||||
---
|
||||
|
||||
A popular use case for collections is to build a portfolio section as part of one's personal site. Let's quickly walk through the steps to do that.
|
||||
|
||||
**Step 1:** Configure the portfolio collection by adding the following to `_config.yml`.
|
||||
|
||||
```yaml
|
||||
collections:
|
||||
portfolio:
|
||||
output: true
|
||||
permalink: /:collection/:path/
|
||||
```
|
||||
|
||||
These settings essentially say output `index.html` files for each portfolio document in `_portfolio` at `_site/portfolio/<document-filename>/`.
|
||||
|
||||
Just like posts and pages you'll probably want to set some defaults for the Front Matter:
|
||||
|
||||
```yaml
|
||||
defaults:
|
||||
# _portfolio
|
||||
- scope:
|
||||
path: ""
|
||||
type: portfolio
|
||||
values:
|
||||
layout: single
|
||||
author_profile: false
|
||||
share: true
|
||||
```
|
||||
|
||||
And then create portfolio content like [`_portfolio/foo-bar-website.md`](https://github.com/{{ site.repository }}/blob/master/docs/_portfolio/foo-bar-website.md), to end up with something like this.
|
||||
|
||||

|
||||
Reference in New Issue
Block a user