Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
DustinFischer committed Jan 21, 2025
1 parent b4892b2 commit 3e50d86
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
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
```

0 comments on commit 3e50d86

Please sign in to comment.