marquage/parsedownanchors

扩展 Parsedown-extra，自动添加具有唯一缩略语的 id 锚点

维护者

详细信息

github.com/marquage/parsedownanchors

主页

源代码

问题

安装: 10

依赖关系: 0

建议者: 0

安全: 0

星标: 1

关注者: 2

分支: 0

开放问题: 0

0.0.2 2019-05-15 17:35 UTC

Requires

Requires (Dev)

MIT d9147272b55dc3a9982d2178832b2a1d0c628052

slugifyanchorsparsedown-extra

This package is auto-updated.

Last update: 2024-09-16 05:54:40 UTC

README

Software License Quality Score

这个小巧的扩展是更大型的基于 markdown 的笔记网站的组成部分。虽然它主要用于构建目录，但这个包只完成了两件事：

  • 它自动为标题（h1-h6）生成 id 锚点，使用 Cocur/Slugify。它不需要提前写下标题缩略语。
  • 它确保每个 id 都是唯一的。从简单的包含测试
## The Site  
## The Site

将变为

<h2 id="the-site">The Site</h2>
<h2 id="the-site-1">The Site</h2>

对于依赖优秀 Tocbot 的更大项目，这已经足够了，但我找不到一个扩展来解决这个问题。还有其他 Parsedown TOC 包，比如 这些 两个。

安装

通过 Composer

$ composer require marquage/parsedownanchors

使用方法

在极不可能的情况下，如果您只需要这个小巧的包，您可以调用它而不是 Parsedown，因为它是一个扩展，您将能够访问 Parsedown-extra 的所有丰富功能。

$parser = new ParsedownSlugified();
$file = file_get_contents('[...]');
return $parser->parse($file);

测试

$ composer test

致谢

许可证

MIT 许可证（MIT）。有关更多信息，请参阅 许可证文件。