【Markdown】使用錨點在頁面之間跳轉

前言

最近項目的文檔都托管到GitLab上的wiki上，包括接口文檔。

于是就需要在上一級頁面直接通過鏈接指向下一級詳細頁面的某個具體API的說明。

所以，需要用到錨點定位。

別人的做法

之前查過別人的博客，大家的做法是

采用div中的id屬性，運用HTML中的錨點做法，來做markdown中的錨點

但是經過我的實踐，這種做法是不能在GitLab上實現的。

自己動手

環境

線上 -> GitLab中的wiki

本地 ->GitLab托管項目中的wiki項目,本地已經部署了gollum

如何部署gollum本文不做展開，其他人的博客還是靠譜的。

GitLab

舉例

第一級頁面文件為 menu.md

第二級頁面文件為api_list.md

api_list.md中大體布局為如下所示

#h1 ##h2/1 text ##h2/2 text

1

2

3

4

5

6

7

8

9

10

11

在一級頁面直接二級頁面某個節點的格式為

[API名字](api_list#h21)

1

已經明確的規則如下

#后面直接接對應的標題內容

不推薦使用中文

如果有/,直接忽略掉

鏈接不要加.md,如果加上的話，會直接跳轉到展示源文件

gollum

經過這次實踐，明白了gollum的作用

本地構建wiki頁面，方便預覽

直接修改文件無效，只渲染git上的最新的提交記錄

頁面上可以直接修改文件，查看修改效果，但是不會作用在本地文件

頁面修改確認無誤后，再通過修改頁面粘貼到本地文件，防止了為了測試效果反復提交版本

鏈接跳轉規則

[API名字](api_list#h1_h2-1)

1

和GitLab不同的是

必須從最高一級標題開始,通過_進行連接

/用-替換

這樣就完成了不同頁面內跳轉的需求。

方法

在預覽界面，鼠標停留在需要跳轉到到的標題前面，復制鏈接地址

總結

每個markdown預覽工具的展示規則可能不會一致

別人寫的博客不一定對

隨著工具版本迭代和自己水平的提高，以前自己寫的博客也不一定對，所以，工具的版本很重要

GitHub Markdown

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。