README

Bard Heading Permalinks 是 Statamic 的一个插件，可以为标题自动添加永久链接，类似于如何将永久链接添加到 markdown 内容。

安装方法

要从项目根目录安装 Bard Heading Permalinks，请运行以下命令

composer require stillat/statamic-bard-heading-permalinks

使用方法

安装后，您需要注册此插件提供的 Bard 扩展。通常在网站的 AppServiceProvider 中完成。

Bard Heading Permalinks 提供了两种不同的扩展

• Permalink：负责在标题中渲染嵌入式链接
• HeadingPermalinkExtension：将永久链接和其他详细信息添加到渲染的标题中

为了方便，您可以同时注册这两个扩展

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Stillat\StatamicBardHeadingPermalinks\HeadingPermalinkExtension;

class AppServiceProvider
{
    public function boot()
    {
        // Register all heading permalink extensions.
        HeadingPermalinkExtension::registerAll();
    }
}

注意：HeadingPermalinkExtension 将替换任何现有的标题扩展。

配置

默认情况下，Bard Heading Permalinks 将使用 heading_permalink 设置来利用 默认 markdown 解析器。有关配置 Statamic 的 markdown 解析器的更多信息，请考虑阅读以下官方文档：[https://statamic.dev/extending/markdown#configuration](https://statamic.dev/extending/markdown#configuration)。

但是，您可以通过从项目根目录运行以下命令来发布 Bard Heading Permalink 的配置文件以覆盖任何设置

php artisan vendor:publish --tag=bard-permalinks-config

将在 config/bard_permalinks.php 创建一个新文件，内容如下

<?php

use League\CommonMark\Extension\HeadingPermalink\HeadingPermalinkRenderer;

return [
    'config' => [
        'html_class' => config('statamic.markdown.configs.default.heading_permalink.html_class', 'heading-permalink'),
        'id_prefix' => config('statamic.markdown.configs.default.heading_permalink.id_prefix', 'content'),
        'apply_id_to_heading' => config('statamic.markdown.configs.default.heading_permalink.apply_id_to_heading', false),
        'heading_class' => config('statamic.markdown.configs.default.heading_permalink.heading_class', ''),
        'fragment_prefix' => config('statamic.markdown.configs.default.heading_permalink.fragment_prefix', 'content'),
        'insert' => config('statamic.markdown.configs.default.heading_permalink.insert', 'before'),
        'min_heading_level' => config('statamic.markdown.configs.default.heading_permalink.min_heading_level', 1),
        'max_heading_level' => config('statamic.markdown.configs.default.heading_permalink.max_heading_level', 6),
        'title' => config('statamic.markdown.configs.default.heading_permalink.title', 'Permalink'),
        'symbol' => config('statamic.markdown.configs.default.heading_permalink.symbol', HeadingPermalinkRenderer::DEFAULT_SYMBOL),
        'aria_hidden' => config('statamic.markdown.configs.default.heading_permalink.aria_hidden', true),
    ],
];

Bard Heading Permalinks 支持 CommonMark 的标题永久链接扩展提供的所有文档配置选项。有关每个配置选项的更多信息，请参阅以下文档页面：[https://commonmark.thephpleague.com/2.4/extensions/heading-permalinks/](https://commonmark.thephpleague.com/2.4/extensions/heading-permalinks/)

许可

Bard Heading Permalinks 是免费软件，根据 MIT 许可发布。