visuellverstehen / statamic-anchor-navigation

Statamic标签,用于创建由Bard编辑器生成的所有标题的锚点导航。

v1.0.0 2024-05-22 14:24 UTC

README

Statamic插件,提供用于创建由Bard编辑器生成的所有标题的锚点导航的自定义标签。

功能

  • 扩展了TipTap标题节点,并为所有配置的标题级别添加了slugified ID(默认为h2)。
  • {{ anchor_navigation }} 标签使得在Bard内容中构建所有标题的锚点导航变得容易。

安装方法

从您的项目根目录运行以下命令

composer require visuellverstehen/statamic-anchor-navigation

使用方法

在您的模板中包含{{ anchor_navigation }} 标签,并提供Bard字段的字段处理程序。

<ul>
    {{ anchor_navigation from="bard" }}
        <li>
            <a href="#{{ id }}">{{ headline }}</a>
        </li>
    {{ /anchor_navigation }}
</ul>

您还可以指定要渲染锚点导航的条目。

<ul>
    {{ anchor_navigation from="bard" :entry="specific_entry" }}
        <li>
            <a href="#{{ id }}">{{ headline }}</a>
        </li>
    {{ /anchor_navigation }}
</ul>

您可以使用count 标签获取内容中找到的标题数量。

{{ if {anchor_navigation:count from="bard"} > 0 }}
    ...
{{ /if }}

配置

您可以定义哪些标题级别应包含在您的锚点导航中。默认为2级标题。

'heading' => [
    'levels' => [2],
],

关于我们

许可证

MIT许可证(MIT)。请参阅许可证文件以获取更多信息。