AutocJs

AutocJs 是一个专门用来生成文章导读(Table of Contents)导航的 JavaScript 工具(原 autocjs 的重构版本,不依赖任何JS库)。AutocJs 会查找文章指定区域中的所有 h1~h6 的标签,并自动分析文章段落间的层次结构,生成文章的导读导航。

创作灵感

AnchorJS 是 AutocJs 的创作灵感来源。既然 AnchorJS 可创建标题的链接,为什么不直接给文章生成一个文章导读(Table of Contents)导航呢? 于是就有了 AutocJs。

特点

安装说明

npm install

CDN 调用

调用本地JS文件

使用说明

Options

article

可选,用来指定页面中显示文章正文的 DOM 节点的 ID 选择器。

selector

可选,用来指定 article 节点下,要生成导航的标题标签的选择器。

title

可选,用来指定文章导读导航菜单的标题文字。

position

可选,用来指定文章导读导航菜单的显示位置:outside - 生成侧边栏菜单,inside - 直接在文章正文区域的开始位置生成导航菜单。

只有设置了 isGenerateOutline 为 true,position 参数才会起效。

anchorURL

可选,用来指定文章标题锚点链接图标的链接地址:'' - 点击链接页面滚动到标题位置,其它 URL 值 - 就直接跳转到指定页面了

anchorAt

可选,用来指定文章标题锚点链接图标的显示位置:'front' - 现在在文章标题前面,'end' - 显示到标题末尾。

isGenerateOutline

可选,用来指定是否文章导读导航菜单:true - 生成菜单,false - 不生成菜单(这样配置基本和 AnchorJS 功能一样了)。

isGenerateOutlineChapterCode

可选,用来指定是否文章导读导航菜单是否显示文章段落层次的索引编号:true - 显示编号,false - 不显示编号。

isGenerateHeadingChapterCode

可选,用来指定是否在文章标题前面显示文章段落层次的索引编号:true - 显示编号,false - 不显示编号。

isGenerateHeadingAnchor

可选,用来指定是否在文章标题位置生成锚点链接图标:true - 生成锚点链接图标,并给标题添加 ID 属性,false - 不生成锚点链接图标,仅给标题添加 ID 属性。

Properties

defaults

静态属性,存储的是 Autoc 对象默认配置信息。

attributes

存储的是 AutocJs 对象当前使用中的配置选项。

elements

存储的是 AutocJs 对象(创建的)相关的 DOM 元素。

data

存储的是 AutocJs 根据标题 DOM 元素分析的数据。

License

JavaScript Code Licensed under MIT License.

API Documentation Licensed under CC BY 3.0