Markdown创建页面和目录?

我开始使用标记来做笔记。

我用标记来查看我的笔记，它很漂亮。

但是随着我的笔记变长，我发现很难找到我想要的东西。

我知道markdown可以创建表，但它是否能够创建目录，跳转到部分，或定义页面部分markdown?

或者，是否有降价阅读器/编辑器可以做这些事情。搜索也是一个不错的功能。

简而言之，我想让它成为我很棒的笔记工具，功能就像写一本书一样。

当前回答

您可以尝试使用这个ruby脚本从标记文件生成TOC。

 #!/usr/bin/env ruby

require 'uri'

fileName = ARGV[0]
fileName = "README.md" if !fileName

File.open(fileName, 'r') do |f|
  inside_code_snippet = false
  f.each_line do |line|
    forbidden_words = ['Table of contents', 'define', 'pragma']
    inside_code_snippet = !inside_code_snippet if line.start_with?('```')
    next if !line.start_with?("#") || forbidden_words.any? { |w| line =~ /#{w}/ } || inside_code_snippet

    title = line.gsub("#", "").strip
    href = URI::encode title.gsub(" ", "-").downcase
    puts "  " * (line.count("#")-1) + "* [#{title}](\##{href})"
  end
end

2014-03-02 17:45:48

其他回答

由不同Markdown解析器生成的锚标记是不相等的。

如果你正在使用Markdown解析器GFM (GitHub调味Markdown)或Redcarpet，我写了一个Vim插件来处理目录。

特性

生成Markdown文件的目录。支持的Markdown解析器: GFM (GitHub调味Markdown) Redcarpet 更新现有的目录。自动更新现有的目录保存。

截图

使用

生成目录

将光标移动到要添加目录的行，然后在下面键入适合您的命令。该命令将在光标进入目录后生成标题。

: GenTocGFM 生成GFM链接样式的目录。此命令适用于GitHub存储库中的Markdown文件，如README。和Markdown文件的GitBook。 : GenTocRedcarpet 生成红地毯链接样式的目录。这个命令适用于Jekyll或任何其他使用Redcarpet作为Markdown解析器的地方。你可以在这里查看GFM和Redcarpet风格的toc链接之间的区别。

手动更新现有的目录

通常你不需要这样做，现有的目录将自动更新保存默认情况下。如果您想手动执行，只需使用:updatettoc命令。

下载和文档

https://github.com/mzlogin/vim-markdown-toc

2016-10-25 04:57:18

有两种方法可以在你的降价文档中创建你的TOC(摘要)。

1. 手动

# My Table of content
- [Section 1](#id-section1)
- [Section 2](#id-section2)

<div id='id-section1'/>
## Section 1
<div id='id-section2'/>
## Section 2

2. 以编程方式

例如，你可以使用一个脚本，为你生成摘要，看看我的项目在github - summarizeMD -

我也尝试过其他脚本/npm模块(例如doctoc)，但没有人用工作锚重现TOC。

2015-04-03 13:28:49

我使用这个网站markdown -TOC创建者，有些人可以粘贴他的整个markdown条目，网站自动创建所有必需的标签和TOC(内容表)，所以有些人可以很容易地复制粘贴到他自己的文档中。

2021-03-19 14:05:24

下面是一个生成目录的简单bash脚本。不需要特殊的依赖项，只需要bash。

https://github.com/Lirt/markdown-toc-bash

它可以很好地处理标题内的特殊符号，标记标题中的链接和忽略代码块。

2021-02-12 15:09:02

如果你的Markdown文件要在bitbucket.org上的回购中显示，你应该在你想要你的目录的位置添加[TOC]。然后它将自动生成。更多信息:

https://confluence.atlassian.com/bitbucket/add-a-table-of-contents-to-a-wiki-221451163.html