AutocJS – 自动为你的文章创建目录导航

AutocJS 的开发灵感

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

AutocJS 是什么?

autocjs是一个专门用来生成文章目录(Table of Contents)导航的 JavaScript 控件。它会查找文章指定区域中的所有 h1~h6 的标签,并自动分析文章的层次结构,生成文章的目录导航(独立的侧边栏菜单,或者在文章的开始处生成文章目录)。

为什么选择 AutocJS

AnchorJS 由于不是中国工程师开发的,所以对中文支持不好,无法给中文标题生成锚点。而 autocjs 即支持英文也支持中文。它在拥有 AnchorJS 的基础功能同时,还可以自动分析文章的层次结构,生成文章的目录导航。

AutocJS 的特点

支持 AMD 和 CMD 规范;

可以作为独立模块使用,也可以作为 jQuery 插件使用;

支持中文和英文(标题文字);

界面简洁大方;

拥有 AnchorJS 的基础功能;

即支持生成独立文章目录导航菜单,又可以直接在文章中生成目录导航;

可直接在段落标题上显示段落层级索引值;

配置灵活,丰富,让你随心所欲掌控;

在浏览器中使用 CDN 文件

Install

Install with npm:

$npm install autocjs

Install width bower

$bower install autocjs

Configuration Options

article

selector

title

isAnchorsOnly

isAnimateScroll

hasChapterCodeAtHeadings

hasChapterCodeInDirectory

hasDirectoryInArticle

Properties

defaults

attributes

elements

data

Methods

reload– (根据新的配置信息)重启程序

set– 设置 attributes 属性

get– 返回某个 attributes 属性

dom– 返回 elements 属性

article– 返回页面文章正文的容器 DOM 元素

headings– 返回 article 中 selector 匹配的所有标题 DOM 元素

chapters– 设置或者返回 data.chapters 属性

anchors– 返回 data.anchors 属性

list– 返回 data.list 属性

index– 返回 chapter 在 data.list 中对应段落层次位置索引值

render– 绘制 UI 界面

show– 展开侧边栏菜单

hide– 收起侧边栏菜单

toggle– 收起/展开侧边栏菜单

resize– 根据当前窗口高度更新侧边栏菜单界面高度

scrollTo– 将窗口的滚动条滚动到指定 top 值的位置

destroy– 移除所有绘制的 DOM 节点,并移除绑定的事件处理器

完整的 API 文档:http://yaohaixiao.github.io/autocjs/

Fork on Github

http://yaohaixiao.github.io/autocjs

Download

master.zip

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,468评论 5 473
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,620评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,427评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,160评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,197评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,334评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,775评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,444评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,628评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,459评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,508评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,210评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,767评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,850评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,076评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,627评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,196评论 2 341

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,319评论 25 707
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 11,988评论 4 60
  • 你站在穿衣镜前,看着里面那个人,开始觉得一切变得陌生,变得不认识,里面那个人是谁,傻傻的笑,没有气质,没有脾气,没...
    煜杰啊煜杰阅读 113评论 0 0
  • 阿囍身高171cm, 历史最高体重150左右, 历史最低体重120左右。 150左右,长这样 120左右,长这样 ...
    阿囍123阅读 174评论 0 0
  • 直接上图: 另外,古典老师还讲了刻意练习,及其与天赋优势的关系,下面简单介绍下。 一、为什么有刻意练习? 1、量...
    王飞侠阅读 292评论 2 1