Disambiguate the placeholder of permalink (#7906)
Merge pull request 7906
This commit is contained in:
parent
88a2835afe
commit
42bf5675e9
|
@ -34,12 +34,13 @@ You can use placeholders to your desired output. For example:
|
||||||
permalink: /:categories/:year/:month/:day/:title:output_ext
|
permalink: /:categories/:year/:month/:day/:title:output_ext
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that pages and collections don't have time or categories, these aspects of
|
Note that pages and collections (excluding `posts` and `drafts`) don't have time
|
||||||
the permalink style are ignored for the output.
|
and categories (for pages, the above `:title` is equivalent to `:basename`), these
|
||||||
|
aspects of the permalink style are ignored for the output.
|
||||||
|
|
||||||
For example, a permalink style of
|
For example, a permalink style of
|
||||||
`/:categories/:year/:month/:day/:title:output_ext` for posts becomes
|
`/:categories/:year/:month/:day/:title:output_ext` for the `posts` collection becomes
|
||||||
`/:title.html` for pages and collections.
|
`/:title.html` for pages and collections (excluding `posts` and `drafts`).
|
||||||
|
|
||||||
### Placeholders
|
### Placeholders
|
||||||
|
|
||||||
|
@ -329,8 +330,8 @@ Rather than typing `permalink: /:categories/:year/:month/:day/:title/`, you can
|
||||||
|
|
||||||
### Collections
|
### Collections
|
||||||
|
|
||||||
For collections, you have the option to override the global permalink in the
|
For collections (including `posts` and `drafts`), you have the option to override
|
||||||
collection configuration in `_config.yml`:
|
the global permalink in the collection configuration in `_config.yml`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
collections:
|
collections:
|
||||||
|
@ -363,7 +364,10 @@ Collections have the following placeholders available:
|
||||||
<p><code>:path</code></p>
|
<p><code>:path</code></p>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<p>Path to the document relative to the collection's directory.</p>
|
<p>
|
||||||
|
Path to the document relative to the collection's directory,
|
||||||
|
including base filename of the document.
|
||||||
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
@ -400,3 +404,54 @@ Collections have the following placeholders available:
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
### Pages
|
||||||
|
|
||||||
|
For pages, you have to use front matter to override the global permalink,
|
||||||
|
and if you set a permalink via front matter defaults in `_config.yml`,
|
||||||
|
it will be ignored.
|
||||||
|
|
||||||
|
Pages have the following placeholders available:
|
||||||
|
|
||||||
|
<div class="mobile-side-scroller">
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Variable</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<p><code>:path</code></p>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>
|
||||||
|
Path to the page relative to the site's source directory, excluding
|
||||||
|
base filename of the page.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<p><code>:basename</code></p>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>The page's base filename</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<p><code>:output_ext</code></p>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>
|
||||||
|
Extension of the output file. (Included by default and usually
|
||||||
|
unnecessary.)
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
|
Loading…
Reference in New Issue