今天偶然间看到文档服务器有一个动态目录功能，点击目录能跳转到指定的位置；窗口滑动也能自动更新目录的焦点。

效果

框架

原来使用的是一个开源的jquery-ui控件——tocify.js，它可以遍历页面，把指定的DOM元素抽取出来形成目录。
下载地址参考gitub : [gfranko/jquery.tocify.js]

开发者可以直接下载zip包使用，压缩包里面的内容包括：

  • demos 演示页面（里面有一个google的链接，访问会超时，去掉即可）
  • images 可以忽略
  • libs 额外使用的文件，如jquery,jquery-ui,bootstrap等等
  • src 源文件（包括js以及css）——重点
  • test 忽略
  • 其他忽略

举个栗子

<!DOCTYPE html>

<html lang="en">

<head>

<meta charset="utf-8">

<link href="styles/bootstrap.css" rel="stylesheet">

<link href="../src/stylesheets/jquery.tocify.css" rel="stylesheet">

<link href="styles/prettify.css" type="text/css" rel="stylesheet" />

<style>

body {

padding-top: 20px;

}

p {

font-size: 16px;

}

.headerDoc {

color: #005580;

}

@media (max-width: 767px) {

#toc {

position: relative;

width: 100%;

margin: 0px 0px 20px 0px;

}

}

</style>

</head>

<body>

<div class="container-fluid">

<div class="row-fluid">

<div class="span3">

<div id="toc">

</div><!--/.well -->

</div><!--/span-->

<div class="span9">

<div class="hero-unit">

<h1>h1-test-aaa</h1>

<h2>h2-test-aaa</h2>

<p>

test

<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>

</p>

<h1>h1-test-bbb</h1>

<h2>h2-test-bbb</h2>

<p>

test

<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>

</p>

<h1>h1-test-ccc</h1>

<h2>h2-test-ccc1</h2>

<h2>h2-test-ccc2</h2>

<p>

test

<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>

</p>

</div><!--/span-->

</div><!--/row-->

</div>

<script src="../libs/jquery/jquery-1.8.3.min.js"></script>

<script src="../libs/jqueryui/jquery-ui-1.9.1.custom.min.js"></script>

<script src="javascripts/bootstrap.js"></script>

<script src="../src/javascripts/jquery.tocify.js"></script>

<script>

$(function() {

var toc = $("#toc").tocify({

selectors: "h1,h2,h3,h4,h5"

});

});

</script>

</body>

</html>

效果就像前面flash中一样

这个控件支持很多的参数,源码中说的比较详细了,下面是默认的参数

// **context**: Accepts String: Any jQuery selector

// The container element that holds all of the elements used to generate the table of contents

context: "body",

// **ignoreSelector**: Accepts String: Any jQuery selector

// A selector to any element that would be matched by selectors that you wish to be ignored

ignoreSelector: null,

// **selectors**: Accepts an Array of Strings: Any jQuery selectors

// The element's used to generate the table of contents. The order is very important since it will determine the table of content's nesting structure

selectors: "h1, h2, h3",

// **showAndHide**: Accepts a boolean: true or false

// Used to determine if elements should be shown and hidden

showAndHide: true,

// **showEffect**: Accepts String: "none", "fadeIn", "show", or "slideDown"

// Used to display any of the table of contents nested items

showEffect: "slideDown",

// **showEffectSpeed**: Accepts Number (milliseconds) or String: "slow", "medium", or "fast"

// The time duration of the show animation

showEffectSpeed: "medium",

// **hideEffect**: Accepts String: "none", "fadeOut", "hide", or "slideUp"

// Used to hide any of the table of contents nested items

hideEffect: "slideUp",

// **hideEffectSpeed**: Accepts Number (milliseconds) or String: "slow", "medium", or "fast"

// The time duration of the hide animation

hideEffectSpeed: "medium",

// **smoothScroll**: Accepts a boolean: true or false

// Determines if a jQuery animation should be used to scroll to specific table of contents items on the page

smoothScroll: true,

// **smoothScrollSpeed**: Accepts Number (milliseconds) or String: "slow", "medium", or "fast"

// The time duration of the smoothScroll animation

smoothScrollSpeed: "medium",

// **scrollTo**: Accepts Number (pixels)

// The amount of space between the top of page and the selected table of contents item after the page has been scrolled

scrollTo: 0,

// **showAndHideOnScroll**: Accepts a boolean: true or false

// Determines if table of contents nested items should be shown and hidden while scrolling

showAndHideOnScroll: true,

// **highlightOnScroll**: Accepts a boolean: true or false

// Determines if table of contents nested items should be highlighted (set to a different color) while scrolling

highlightOnScroll: true,

// **highlightOffset**: Accepts a number

// The offset distance in pixels to trigger the next active table of contents item

highlightOffset: 40,

// **theme**: Accepts a string: "bootstrap", "jqueryui", or "none"

// Determines if Twitter Bootstrap, jQueryUI, or Tocify classes should be added to the table of contents

theme: "bootstrap",

// **extendPage**: Accepts a boolean: true or false

// If a user scrolls to the bottom of the page and the page is not tall enough to scroll to the last table of contents item, then the page height is increased

extendPage: true,

// **extendPageOffset**: Accepts a number: pixels

// How close to the bottom of the page a user must scroll before the page is extended

extendPageOffset: 100,

// **history**: Accepts a boolean: true or false

// Adds a hash to the page url to maintain history

history: true,

// **scrollHistory**: Accepts a boolean: true or false

// Adds a hash to the page url, to maintain history, when scrolling to a TOC item

scrollHistory: false,

// **hashGenerator**: How the hash value (the anchor segment of the URL, following the

// # character) will be generated.

//

// "compact" (default) - #CompressesEverythingTogether

// "pretty" - #looks-like-a-nice-url-and-is-easily-readable

// function(text, element){} - Your own hash generation function that accepts the text as an

// argument, and returns the hash value.

hashGenerator: "compact",

// **highlightDefault**: Accepts a boolean: true or false

// Set's the first TOC item as active if no other TOC item is active.

highlightDefault: true

前端那点事儿——Tocify自动生成文档目录的更多相关文章

  1. 使用swagger在netcorewebapi项目中自动生成文档

    一.背景 随着前后端分离模式大行其道,我们需要将后端接口撰写成文档提供给前端,前端可以查看我们的接口,并测试,提高我们的开发效率,减少无效的沟通.在此情况下,通过代码自动生成文档,这种需求应运而生,s ...

  2. 使用 Swagger 自动生成 ASP.NET Core Web API 的文档、在线帮助测试文档（ASP.NET Core Web API 自动生成文档）

    对于开发人员来说,构建一个消费应用程序时去了解各种各样的 API 是一个巨大的挑战.在你的 Web API 项目中使用 Swagger 的 .NET Core 封装 Swashbuckle 可以帮助你 ...

  3. MVC WEB api 自动生成文档

    最近在一直在用webapi做接口给移动端用.但是让我纠结的时候每次新加接口或者改动接口的时候,就需要重新修改文档这让我很是苦恼.无意中发现.webapi居然有自动生成文档的功能....真是看见了救星啊 ...

  4. eoLinker 新功能发布，增加了识别代码注释自动生成文档功能

    产品地址:https://www.eolinker.com开源代码:https://www.eolinker.com/#/os/download在线生成代码注释工具:http://tool.eolin ...

  5. SpringBoot 集成Swagger2自动生成文档和导出成静态文件

    目录 1. 简介 2. 集成Swagger2 2.1 导入Swagger库 2.2 配置Swagger基本信息 2.3 使用Swagger注解 2.4 文档效果图 3. 常用注解介绍 4. Swagg ...

  6. 【Sphinx】 为Python自动生成文档

    sphinx 前言 Sphinx是一个可以用于Python的自动文档生成工具,可以自动的把docstring转换为文档,并支持多种输出格式包括html,latex,pdf等 开始 建一个存放文档的do ...

  7. 使用doctest代码测试和Sphinx自动生成文档

    python代码测试并自动生成文档 Tips:两大工具:doctest--单元测试.Sphinx--自动生成文档 1.doctest doctest是python自带的一个模块.doctest有两种使 ...

  8. 用doxygen自动生成文档

    1. 添加符合doxygen解析规则的注释 (比如函数说明,函数参数/返回值说明) 用qt-creator可以在函数上方一行键入“/**”,然后直接回车,就可以自动生成默认的格式. 2. 安装doxy ...

  9. 使用Sphinx为你的python模块自动生成文档

    Sphinx是一个可以用于Python的自动文档生成工具,可以自动的把docstring转换为文档,并支持多种输出格式包括html,latex,pdf等. 安装 创建一个sphinx项目 下面的命令会 ...

随机推荐

  1. Dancing Links & Algorithm X

    1 参考链接 http://www.cnblogs.com/steady/archive/2011/03/15/1984791.html#undefined http://en.wikipedia.o ...

  2. Java 第16章 封装

    封装(encapsulation)     类使得数据和对数据的操作集成在一起,从而对使用该类的其他人来说,可以不管它的实现方法,而只管用它的功能,从而实现所谓的信息隐藏. 封装 , 使用类图描述类 ...

  3. 通过其他页面跳转到tableBar指示的界面

    通过代理实现 让tableBar遵从代理,让代理的实现方法设置 [self setSelectedIndex:2]; setSelectedIndex:2 代表tableBar的item第3个处于选中 ...

  4. 【转】Linux中xargs的用法

    xargs大 多数 Linux 命令都会产生输出:文件列表.字符串列表等.但如果要使用其他某个命令并将前一个命令的输出作为参数该怎么办?例如,file 命令显示文件类型(可执行文件.ascii 文本等 ...

  5. 【DP】组合数字

    Password Attacker 题意就是给 M 个关键字,组合成 N 字符长度的结果,每一个关键字都必须在 N 位的字符中出现,有多少种可能结果. 范围 1 ≤ M ≤ N ≤ 100. 举例假设 ...

  6. ORA-00060：等待资源时检测到死锁的一种处理方法

    先执行脚本: SELECT p.sipid, a.serial#, c.object_name, b.session_id, b.oracle_username, b.os_user_name FRO ...

  7. 多线程NSInvocationOperation(NSOperationQueue)的基本用法

        #import "ViewController.h" @interface ViewController () @end @implementation ViewContr ...

  8. [CSDN转载]致C语言初学者—指针注意项

    在论坛里经常见到一些新人对指针提出一些问题,作为一个经历过许多错误后的新手,我想把自己的经历说出来,避免让后来人继续这样的错误.    在讲解指针之前,需要理解一下内存空间.内存是随机存取器,计算机上 ...

  9. vpn找不到设备，win7建立新的VPN总时显示错误711，无法启动 Remote Access Connection Manager 及 Remote Access Auto Connection Manager 错误1068

    试试相关服务!一.remote access connection manager是网络连接的服务,它依赖于Technology服务,现在你的这个服务已经启动,而Secure Socket Tunne ...

  10. Select for update/lock in share mode 对事务并发性影响

    select for update/lock in share mode 对事务并发性影响 事务并发性理解 事务并发性,粗略的理解就是单位时间内能够执行的事务数量,常见的单位是 TPS( transa ...