• 前言
• markdown頁內(nèi)跳轉(zhuǎn)
• 使用doctoc生成目錄
  • 安裝doctoc
  • 目錄生成
  • 目錄更新

前言

markdown語法簡單好用又容易上手，本人是markdown的鐵粉。這篇文章記錄markdown的頁內(nèi)跳轉(zhuǎn)語法以及使用doctoc生成目錄。
不過尷尬的是簡書不支持頁內(nèi)跳轉(zhuǎn)(手動嘔吐)。

markdown頁內(nèi)跳轉(zhuǎn)

格式：[顯示的標題](#目標目錄的標題)，其中目標目錄標題中有空格時用 - 替換空格。
舉個栗子：[點擊這里進行頁面跳轉(zhuǎn)](#使用doctoc生成目錄)
顯示為：點擊這里進行頁面跳轉(zhuǎn)

使用doctoc生成目錄

當(dāng)文章內(nèi)容比較多，篇幅過長的時候，我們會想在文章的開頭加上目錄，使閱讀者能清晰的看到整篇文章的結(jié)構(gòu)。除了手動添加之外，我們可以添加一個全局的工具doctoc，在需要時，執(zhí)行一行命令就可以為我們生成目錄。

安裝doctoc

使用如下命令全局安裝doctoc：

npm i doctoc -g //install 簡寫 i

如果Mac電腦上因為沒有權(quán)限而報錯，如下：

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

根據(jù)提示輸入密碼之后，就可以完成安裝了。

目錄生成

生成目錄的命令如下：

doctoc 路徑/markdown頁內(nèi)跳轉(zhuǎn)和目錄生成.md

執(zhí)行成功之后，就會看到目錄已經(jīng)生成在文章的最頂端了。如果需要調(diào)整位置，可以手動進行調(diào)整。

目錄更新

如果目錄有變更，可以使用生成目錄的命令進行重新生成。也可以使用更新命令進行目錄更新，命令如下：

doctoc 路徑/markdown頁內(nèi)跳轉(zhuǎn)和目錄生成.md -u

執(zhí)行成功之后，目錄就會被原地更新。