Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document heading_level for heading blocks #4502

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document heading_level for heading blocks #4502

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/building_blocks_for_flexible_content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,12 +121,13 @@ When added through Whitehall content can either be written in HTML or govspeak m

A wrapper around the [Heading component](https://components.publishing.service.gov.uk/component-guide/heading). This block uses `content` where the component uses `text` for the title text key. This is so that headings can appear in search (only values inside a `content` key will be indexed when being published from Whitehall - see [Indexing block content in search](#indexing-block-content-in-search))

If an `id` is added, the heading can be referenced in an anchor link.
If an `id` is added, the heading can be referenced in an anchor link. `heading_level` can be used to specify the heading level (the default is 2) - you should usually have at least one `heading_level: 1` towards the beginning of a page's content.

```yaml
- type: heading
id: heading-id
content: Porem ipsum dolor
heading_level: 3
```

#### Image
Expand Down
Loading