anchorhub 0.14

功能

• 轻松使用Github自动生成的定位标记
• 简单的、可自定义的语法，只起作用
• 使用单个文件、单个目录级别或整个 目录树

安装

您可以使用 pip：

$ pip install anchorhub

如果PIP有问题，也可以从源代码安装：

$ git clone https://github.com/samjabrahams/anchorhub.git
$ cd anchorhub
$ python setup.py install

待办事项列表

• 验证跨平台兼容性（目前仅在OSX上测试）
• 支持重构文本
• 定义用于使用自定义锚生成或
• 更多的测试！

已知问题

• 不应更改行内代码块（那些标记为` 反勾号）

一。定义您的标签

在标记文件中，在标题行的末尾定义标记。由 默认情况下，语法为{#my-tag-here}：

# This is a header that I would like to make a tag for {#tag}

You can also use Setext (underlined) style headers {#setext}
------------------------------------------------------------

默认值类似于Pandoc’s Markdown header identifiers

2.像使用常规html锚那样使用标记

在其他地方，可以使用链接中以前定义的标记来提供 标题的直接路径：

[This links back to the header using the AnchorHub tag 'tag'](#tag)

[This one links to the Setext header](#setext)

三。在标记文件上运行anchorhub

anchorhub将分析标记文件。你有几个选择 对于运行anchorhub：在单个文件上运行，在单个文件上运行 一个目录的级别，或者在整个目录树上运行它。

Single file use:
$ anchorhub mytags.md

Directory use (single level):
$ anchorhub .

Directory use (provided directory level and all subdirectories):
$ anchorhub . -r

这将把处理过的文件输出到当前文件夹中的新文件夹中 目录，“anchorhub out/”

四。享受您的（相对而言）免费github锚链接

假设上面所有的标记都在一个名为“mytags.md”的文件中，这里 是我们在“anchorhub out/mytags.md”中找到的：

# This is a header that I would like to make a tag for

You can also use Setext (underlined) style headers
------------------------------------------------------------
...
[This links back to the header using the AnchorHub tag 'tag'](#this-is-a-header-that-i-would-like-to-make-a-tag-for)

[This one links to the Setext header](#you-can-also-use-setext-underlined-style-headers)