前言
markdown语法简单好用又容易上手,本人是markdown的铁粉。这篇文章记录markdown的页内跳转语法以及使用doctoc生成目录。
不过尴尬的是简书不支持页内跳转(手动呕吐)。
markdown页内跳转
格式:[显示的标题](#目标目录的标题)
,其中目标目录标题
中有空格
时用 -
替换空格
。
举个栗子:[点击这里进行页面跳转](#使用doctoc生成目录)
显示为:点击这里进行页面跳转
使用doctoc生成目录
当文章内容比较多,篇幅过长的时候,我们会想在文章的开头加上目录,使阅读者能清晰的看到整篇文章的结构。除了手动添加之外,我们可以添加一个全局的工具doctoc
,在需要时,执行一行命令就可以为我们生成目录。
安装doctoc
使用如下命令全局安装doctoc
:
npm i doctoc -g //install 简写 i
如果Mac电脑上因为没有权限而报错,如下:
npm WARN checkPermissions Missing write access to /usr/local/lib/node_modules
npm ERR! code EACCES
npm ERR! syscall access
npm ERR! path /usr/local/lib/node_modules
npm ERR! errno -13
npm ERR! Error: EACCES: permission denied, access '/usr/local/lib/node_modules'
npm ERR! [Error: EACCES: permission denied, access '/usr/local/lib/node_modules'] {
npm ERR! errno: -13,
npm ERR! code: 'EACCES',
npm ERR! syscall: 'access',
npm ERR! path: '/usr/local/lib/node_modules'
npm ERR! }
npm ERR!
npm ERR! The operation was rejected by your operating system.
npm ERR! It is likely you do not have the permissions to access this file as the current user
npm ERR!
npm ERR! If you believe this might be a permissions issue, please double-check the
npm ERR! permissions of the file and its containing directories, or try running
npm ERR! the command again as root/Administrator.
npm ERR! A complete log of this run can be found in:
npm ERR! /Users/HMX/.npm/_logs/2021-09-27T02_31_22_475Z-debug.log
可以在命令前加上sudo
,如下:
sudo npm i doctoc -g
根据提示输入密码之后,就可以完成安装了。
目录生成
生成目录的命令如下:
doctoc 路径/markdown页内跳转和目录生成.md
执行成功之后,就会看到目录已经生成在文章的最顶端了。如果需要调整位置,可以手动进行调整。
目录更新
如果目录有变更,可以使用生成目录的命令进行重新生成。也可以使用更新命令进行目录更新,命令如下:
doctoc 路径/markdown页内跳转和目录生成.md -u
执行成功之后,目录就会被原地更新。