https://github.com/visuellverstehen/statamic-anchor-navigation
Statamic Anchor Navigation is a Statamic addon that helps you build a server side anchor navigation from your bard content.
https://github.com/visuellverstehen/statamic-anchor-navigation
Last synced: 16 days ago
JSON representation
Statamic Anchor Navigation is a Statamic addon that helps you build a server side anchor navigation from your bard content.
- Host: GitHub
- URL: https://github.com/visuellverstehen/statamic-anchor-navigation
- Owner: visuellverstehen
- License: mit
- Created: 2023-03-21T10:25:10.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T13:00:42.000Z (11 months ago)
- Last Synced: 2024-05-22T13:56:52.544Z (11 months ago)
- Language: PHP
- Size: 49.8 KB
- Stars: 2
- Watchers: 6
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Statamic Anchor Navigation
A Statamic addon that provides a custom tag for creating an anchor nav for all headings generated by the bard editor.
## Features
- Extends the TipTap heading node and adds a slugified ID to all configured heading levels (defaults to h2).
- The `{{ anchor_navigation }}` tag makes it easy to build an anchor navigation for all headings within your bard content.
## How to install
Run the following command from your project root:
``` bash
composer require visuellverstehen/statamic-anchor-navigation
```
## How to use
Include the `{{ anchor_navigation }}` tag in your template and supply the field handle of your bard field.
```
-
{{ headline }}
{{ anchor_navigation from="bard" }}
{{ /anchor_navigation }}
```
You also specify the entry from which you want to render the anchor navigation.
```
-
{{ headline }}
{{ anchor_navigation from="bard" :entry="specific_entry" }}
{{ /anchor_navigation }}
```
You can get the amount of headings found within the content with the `count` tag:
```
{{ if {anchor_navigation:count from="bard"} > 0 }}
...
{{ /if }}
```
## Configurations
You can define which heading levels should be included in your anchor navigation. Level 2 headings are set as a default.
```
'heading' => [
'levels' => [2],
],
```
## More about us
- [www.visuellverstehen.de](https://visuellverstehen.de)
## License
The MIT license (MIT). Please take a look at the [license file](LICENSE.md) for more information.