Skip to content

docs/configuration: GitHub table display was messed up #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jekyllbot merged 1 commit into from
Oct 26, 2017
Merged

docs/configuration: GitHub table display was messed up #96

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,10 @@ jekyll-archives:
---

#### Enabled archives
| Key | Value type | Values |
|---|---|---|---|
| Key | Value type | Values |
|-----------|-----------------|--------|
| `enabled` | String or Array | `'all'` or an array of any combination of `year`, `month`, `day`, `categories`, `tags` |

##### Description
This option sets which types of archives will be created. Must be set to an array of enabled archive types, or the string 'all' (to enable all archives).
##### Sample values
Expand All @@ -47,9 +48,10 @@ enabled:
---

#### Default layout
| Key | Value type | Values |
|---|---|---|---|
| `layout` | String | The layout name of the default archive layout |
| Key | Value type | Values |
|----------|------------|--------|
| `layout` | String | The layout name of the default archive layout |

##### Description
Sets the default layout to use if no type-specific layout (see [Type-specific layouts](#type-specific-layouts) below) for an archive is specified.
##### Sample values
Expand All @@ -61,9 +63,10 @@ layout: custom-archive-layout # _layouts/custom-archive-layout.html
---

#### Type-specific layouts
| Key | Value type | Values |
|---|---|---|---|
| Key | Value type | Values |
|-----------|---------------------------|--------|
| `layouts` | Map, String → String | A map of layout type (`year`, `month`, `day`, `category`, `tag`) to its archive name. |

##### Description
Maps archive types to the layout they will be rendered in. Not all types need to be specified; those without a specific layout will fall back to the default layout.
##### Sample values
Expand All @@ -78,9 +81,10 @@ layouts:
---

#### Permalinks
| Key | Value type | Values |
|---|---|---|---|
| Key | Value type | Values |
|--------------|---------------------------|--------|
| `permalinks` | Map, String → String | A map of layout type (`year`, `month`, `day`, `category`, `tag`) to its permalink format. |

##### Description
Maps archive types to the permalink format used for archive pages. The permalink style is the same as regular Jekyll posts and pages, but with different variables.

Expand Down