-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b4892b2
commit 3e50d86
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,30 @@ | ||
# presidium-layouts-base | ||
Base Hugo layouts for Presidium | ||
|
||
## Custom Output Formats | ||
|
||
### Snippets | ||
|
||
The `Snippet` output format is a alternative HTML output format to the standard output (`index.html`) for _pages_ and _sections_. It's intended for generating standalone articles that can be used in third-party/isolated contexts (such as in an `iframe`). | ||
|
||
Features of a snippet: | ||
- Generates content from the `content/` directory. | ||
- Uses the same stylesheets as the standard output. | ||
- Excludes inter-host navigation contexts that are in the standard output, such as the toolbar and left sidebar. | ||
- Includes breadcrumbs to ancestor snippets for limited navigation within the docset. | ||
|
||
**Usage** | ||
|
||
Snippet outputs must be configured per docset repository in `config.yml`. | ||
|
||
```yaml | ||
# <my-docset>/config.yml | ||
... | ||
outputs: | ||
page: | ||
- html # -> index.html | ||
- snippet # -> snippet.html | ||
section: | ||
- html # -> index.html | ||
- snippet # -> snippet.html | ||
``` |