outline.js - 自动生成文章导读导航的 JavaScript 工具

2024-03-27T10:14:59

outline.js - 自动生成文章导读(Table of Contents)导航的 JavaScript 工具。会自动分析文章中的标题( h1~h6 )标签,并生成文章段落层次结构的导读导航菜单。

特点

原生 JavaScript 编写,无需任何依赖;
支持 UMD 规范;
支持 E6 模块,提供功能独立的 ES6 模块;
Anchors 模块:类似 AnchorJS 基础功能模块,自动分析段落层级
Drawer 模块:独立的侧滑窗口模块
Chapters 模块:独立的导航菜单模块;
Toolbar 模块:独立的固定定位的工具栏模块;
拥有 AnchorJS 基础功能;
支持中文和英文标题文字生成ID;
支持生成独立的侧边栏导航菜单;
支持直接在文章中指定的 DOM 元素内生成文章导读导航(fixed 或者 sticky 布局);
自动分析标题关系,生成段落层级索引值;
支持配置自定义工具栏按钮和按钮的回调函数;
支持针对(github 项目的)API 文档的 tags 和 issues 等按钮的跳转;
支持自定义图标的自定义按钮,并且支持配置自定义按钮的触发事件和事件处理器;
自动为文章页面添加通用的打印样式;
(在配置打印样式后)有纯净的阅读视图(按ESC键可退出);
针对超长文章,采用 time slice 机制优化性能;
可以作为 jQuery 插件使用;
界面简洁大方;
配置灵活,丰富,让你随心所欲掌控 outline.js;
说明:outline.js 的 Wiki 中介绍了实现自动计算段落层次的算法

[x-github url="https://github.com/yaohaixiao/outline.js"/]

当前页面是本站的「Baidu MIP」版。发表评论请点击:完整版 »