outline.js 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
outline.js 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
outline.js 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 MIT
开发语言 JavaScript
操作系统 跨平台
软件类型 开源软件
开源组织
地区 国产
投 递 者 自由的巨浪
适用人群 未知
收录时间 2023-08-01

软件简介

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

创作灵感

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

特点

  • 原生 JavaScript 编写,无需任何依赖;
  • 支持 UMD 规范;
  • 支持 E6 模块,提供功能独立的 ES6 模块;
    • **Anchors 模块:**类似 AnchorJS 基础功能模块,自动分析段落层级
    • **Drawer 模块:**独立的侧滑窗口模块
    • **Chapters 模块:**独立的导航菜单模块;
    • **Toolbar 模块:**独立的固定定位的工具栏模块;
  • 拥有 AnchorJS 基础功能;
  • 支持中文和英文标题文字生成ID;
  • 支持生成独立的侧边栏导航菜单;
  • 支持直接在文章中指定的 DOM 元素内生成文章导读导航(fixed 或者 sticky 布局);
  • 自动分析标题关系,生成段落层级索引值;
  • 可以作为 jQuery 插件使用;
  • 界面简洁大方;
  • 配置灵活,丰富,让你随心所欲掌控 outline.js;

Examples

outline.js 的支持的滚动元素可以是 Window 窗口,也可以是某个 DOM 元素。

窗口滚动

独立侧滑菜单

sticky 定位

fixed 定位

DOM 元素滚动

flex 布局

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论

点击引领话题📣 发布并加入讨论🔥
发表了资讯
09/23 11:51

outline.js 3.30.0 已经发布,自动生成文章导读导航

outline.js 3.30.0 已经发布,自动生成文章导读导航 此版本更新内容包括: Features 添加 hasToolbar 配置,可以隐藏按钮工具栏; 添加 Anchors 模块的独立调用实例; (b5ec0d4) 详情查看:https://gitee.com/yaohaixiao/outline.js/releases/3.30.0

0
1
发表了资讯
09/14 14:16

outline.js 3.28.0 已经发布,自动生成文章导读导航

outline.js 3.28.0 已经发布,自动生成文章导读导航 此版本更新内容包括: Bug Fixes 修复在文章中显示 chapters 导航,收起时没有动画的问题; Features 添加 print() 方法,并添加 API 说明; 采用延迟绘制合克隆节点的方式,优化 print 界面绘制的性能; (1fad980) 详情查看:https://gitee.com/yaohaixiao/outline.js/releases/3.28.0...

0
2
发表了资讯
09/06 17:53

outline.js 3.24.2 已经发布,自动生成文章导读导航

outline.js 3.24.2 已经发布,自动生成文章导读导航 此版本更新内容包括: Bug Fixes 修复 utils 中 cloneDeep() 方法复制数据的逻辑错误 (33ac030) 详情查看:https://gitee.com/yaohaixiao/outline.js/releases/3.24.2

0
0
发表了资讯
09/06 11:58

outline.js 3.24.1 已经发布,自动生成文章导读导航

outline.js 3.24.1 已经发布,自动生成文章导读导航 此版本更新内容包括: Bug Fixes 修复针对超长文章使用 timeSlice 机制异步绘制 anchors 链接后,针对标题的和导航菜单的 IntersectionObserver 同步高亮当前(异步绘制的)标题无效的问题; (e3a468f). 详情查看:https://gitee.com/yaohaixiao/outline.js/releases/3.24.1...

0
1
发表了资讯
09/04 15:42

outline.js 3.24.0 已经发布,自动生成文章导读导航

outline.js 3.24.0 已经发布,自动生成文章导读导航 此版本更新内容包括: Features 优化 anchors.js 中创建图标链接的性能; (b23312c) 针对超长文章,采用 time slice 机制优化性能; (19d5ee8) 详情查看:https://gitee.com/yaohaixiao/outline.js/releases/3.24.0

1
1
发表了资讯
08/31 15:51

outline.js 3.23.0 已经发布,自动生成文章导读导航

outline.js 3.23.0 已经发布,自动生成文章导读导航 此版本更新内容包括: Features 调整打印样式中文章标题的下边距 (6691f8d) 调整所有 DOM 元素的绘制逻辑,调用 createElement() 方法中的插入单个子元素,直接用 DOM 元素,较少数组循环的多余调用成本; 调整 print() 方法,将更新邻居节点逻辑提取为独立的私有方法; (4a96ecf) 详情查看:https://gitee.com/yaohaixiao/outline.js/releases/3.23.0...

0
1
发表了资讯
08/29 18:27

outline.js 3.22.1 已经发布,自动生成文章导读导航

outline.js 3.22.1 已经发布,自动生成文章导读导航 此版本更新内容包括: Bug Fixes 修复 sticky 定位,窗口调整大小,chapters 导航栏高度没有自适应窗口大小变化的问题 (4694b3c) Features 调整打印样式中文章标题的下边距; 调整代码结构,重新打包文件 (556e186) 详情查看:https://gitee.com/yaohaixiao/outline.js/releases/3.22.1...

0
1
发表了资讯
08/29 10:25

outline.js 3.21.0 已经发布,自动生成文章导读导航

outline.js 3.21.0 已经发布,自动生成文章导读导航 此版本更新内容包括: Features 添加 $emit()、$on()、$off() 方法; 添加 created、mounted、enterReading、exitReading、beforeDestroy 和 destroyed 事件; (88b087d) 详情查看:https://gitee.com/yaohaixiao/outline.js/releases/3.21.0...

0
0
发表了资讯
08/15 13:09

outline.js 3.16.0 已经发布,自动生成文章导读导航

outline.js 3.16.0 已经发布,自动生成文章导读导航 此版本更新内容包括: Features 调整 title 配置参数的可选值,增加设置“”或者false,不显示导航菜单的标题栏; 调整 toolbar 工具栏内置按钮的显示顺序; (a143ed9) 详情查看:https://gitee.com/yaohaixiao/outline.js/releases/3.16.0

0
1
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表了博客
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
发表了问答
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
暂无内容
0 评论
21 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部