wires/hypnagaga_old
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update schema handling and add docs entry for it

Browse source
This commit is contained in:
madrilene 2025-01-19 07:35:05 +01:00
parent 4d130a90b7
commit 9bd7b0ba10
5 changed files with 61 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/_includes/head/schema.njk
View file

@ -1,5 +1,5 @@
<!-- inline base schema -->
{% include "schemas/base-schema.njk" %}
{% include "schemas/WebSite.njk" %}
<!-- inline blogpost schema -->
{% if schema == 'blog' %}{%- include "schemas/blogpost-schema.njk" -%}{% endif %}
{% if schema %}
{%- include "schemas/" + schema + ".njk" -%}
{% endif %}

0
src/_includes/schemas/blogpost-schema.njk → src/_includes/schemas/BlogPosting.njk
View file

0
src/_includes/schemas/base-schema.njk → src/_includes/schemas/WebSite.njk
View file

2
src/_layouts/post.njk
View file

@ -1,6 +1,6 @@
---
layout: base
schema: blog
schema: BlogPosting
---
<article class="region" style="--region-space-top: var(--space-xl-2xl)">

56
src/docs/schema.md Normal file
View file

@ -0,0 +1,56 @@
---
title: Schema
---
Schema markup provides additional context for search engines and screen readers. The main schema template is included in the `<head>` via `src/_includes/head/schema.njk`. New schemas should be placed in `src/_includes/schemas/`.
To use the "BlogPosting" schema, set the schema key in the front matter:
```yaml
---
schema: BlogPosting
---
```
To use an Event schema for example, create a template at `src/_includes/schemas/Event.njk`, with something similar to:
{% raw %}
```jinja2
<script type="application/ld+json">
{
"@context": "http://schema.org",
"@type": "Event",
"location": {
"@type": "Place",
"address": {
"@type": "PostalAddress",
"addressLocality": "{{ event.data.place.city }}",
"postalCode": "{{ event.data.place.plz }}",
"streetAddress": "{{ event.data.place.street }}"
},
"name": "{{ event.data.place.name }}"
},
"name": "{{ event.data.title }}",
"description": "{{ event.data.description }}",
"startDate": "{{ event.data.date }}",
"performer": "{{ event.data.artist }}"
}
</script>
```
{% endraw %}
And reference it in the front matter:
```yaml
---
schema: Event
---
```