diff --git a/docs/configuration.md b/docs/configuration.md index 32a79bd..5edb144 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -28,9 +28,10 @@ jekyll-archives: --- #### Enabled archives -| Key | Value type | Values | -|---|---|---|---| -| `enabled` | String or Array | `'all'` or an array of any combination of `year`, `month`, `day`, `categories`, `tags` | +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 @@ -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 @@ -61,9 +63,10 @@ layout: custom-archive-layout # _layouts/custom-archive-layout.html --- #### Type-specific layouts -| Key | Value type | Values | -|---|---|---|---| -| `layouts` | Map, String → String | A map of layout type (`year`, `month`, `day`, `category`, `tag`) to its archive name. | +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 @@ -78,9 +81,10 @@ layouts: --- #### Permalinks -| Key | Value type | Values | -|---|---|---|---| -| `permalinks` | Map, String → String | A map of layout type (`year`, `month`, `day`, `category`, `tag`) to its permalink format. | +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.