diff options
| author | Sheogorath | 2019-10-10 14:55:34 +0200 |
|---|---|---|
| committer | GitHub | 2019-10-10 14:55:34 +0200 |
| commit | cd34a8c70226a094b5698ae7ab8b3bcd5ce75b41 (patch) | |
| tree | e7839d0751fea4f8e5deaed9560657c6ad97f946 /public/docs | |
| parent | 3255649917569eb8f1bed02b1aed8045322736e4 (diff) | |
| parent | f26f48793fdf5bb81f4bec5d7c50e5fe1ba978d6 (diff) | |
Merge pull request #191 from ErikMichelson/feature/ogmetadata
Add customizable opengraph metadata for notes (see #40)
Diffstat (limited to 'public/docs')
| -rw-r--r-- | public/docs/yaml-metadata.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/public/docs/yaml-metadata.md b/public/docs/yaml-metadata.md index 8e59c8f2..f09591bc 100644 --- a/public/docs/yaml-metadata.md +++ b/public/docs/yaml-metadata.md @@ -159,3 +159,20 @@ slideOptions: transition: fade theme: white ``` + +opengraph +--- +This option allows you to override the default generated opengraph metadata. +See the [OpenGraph protocol documentation](https://ogp.me) for more information. + +**Notice: always use two spaces as indention in YAML metadata!** + +> default: not set (uses auto-generated metadata) + +**Example** +```yml +opengraph: + title: Special title for OpenGraph protocol + image: https://dummyimage.com/600x600/000/fff + image:type: image/png +``` |