GitHub Wiki中的ToC或邊欄

如何在GitHub Wiki中創建ToC或邊欄菜單？GitHub Wiki中的ToC或邊欄

我看到一些提及它和gollum後端似乎支持它，但我該如何在當前的GitHub項目中做到這一點？

它應該最好基於我自動在頁面中的標題。

這些鏈接都提到它，但不顯示怎麼辦呢：

https://gist.github.com/379469 - 一些JavaScript破解
https://github.com/blog/774-git-powered-wikis-improved - GitHub上提到這一點：

「GitHub的維基有一點點 - 腳本和側邊欄的文檔化功能，這是我們基於git的Wiki作者所熟悉的一些功能。新的Wiki編輯器爲您提供有限的基於網頁的編輯腳註和側邊欄喲你有你的網站。「

2012-02-11 wolle

我開發了GitHub Wikifier：一個預先提交的Git Hook，它將生成您將需要的所有目錄。只要寫下你的內容，然後讓它接管。可能值得一檢查。 https://github.com/kuroir/GitHub-Wikifier – MarioRicalde 2012-12-29 08:58:23

在艾薩克斯上：https：//github.com/isaacs/github/issues/504 – 2015-10-30 19:12:53

好吧，讓我看看我是否正確理解這個：

克隆你的GitHub wiki（這裏有一個Git部分，你可以檢查你的類似wiki代碼。）
創建_Sidebar.md
在正常的維基網頁，使用[[link]]側邊欄
提交併推回GitHub的

這個過程是一個痛苦的屁股。我很驚訝這個「gollum」wiki有任何接受。

另外：因此_Sidebar.md是所有頁面全球。我必須將我的wiki組織到文件夾中，以便我可以爲不同的頁面定義不同的側邊欄。

來源

2012-02-17 11:40:17 wolle

根據文檔，你可以爲不同的文件夾添加不同的側邊欄：「側邊欄會影響其目錄中的所有頁面以及任何沒有自己的側邊欄文件的子目錄。「請參閱：https://github.com/github/gollum – Subfuzion 2012-05-07 03:43:41

我認爲這是在Gollum README描述（見頭和側邊欄部分）。

本質上講，你在包含頁面內容的目錄進行_footer.ext和_sidebar.ext。

來源

2012-02-11 11:04:42 seandavi

儘管您的解決方案有效，但使用GitHub的Web界面還是有一種更簡單的方法。您可以簡單地創建一個名爲_Sidebar和/或_Footer的頁面。

查看的詳細說明ADDING A TABLE OF CONTENTS TO YOUR GITHUB WIKI。

來源

2012-04-09 03:58:24 nicerobot

我在幾個月前關注此帖。效果很好。但是，現在我想刪除邊欄並且無法弄清楚。任何同樣精彩的建議？ – 2013-01-11 21:59:30

@CodeSherpa可通過https://github.com/ [user]/[repo]/wiki/_Sidebar/_edit'和'https://github.com/[user]/[repo]/wiki/訪問它們_Footer/_edit' – nicerobot 2013-01-12 01:12:00

哦，hooray！更多的輝煌 - 謝謝你nicerobot！ – 2013-01-13 21:52:07

請注意，最初的問題是關於創建一個側欄（容易，在答案中解決）或實際目錄（未回答）。

我可以說的一件事是，gollum 2.1 wiki語法允許使用[[_TOC_]]標記，但GitHub wiki不會識別（還？）。

來源

2013-12-29 10:41:57 mark

你有沒有運氣？來自Trac的所有這些事情都很容易完成，這是非常令人沮喪的。 – jooks 2013-12-30 19:32:02

我認爲對於如何製作「基於頁面中的標題自動生成」的原始問題，更好的答案是GitHub Wiki目前不可能的。 – avernet 2014-06-06 00:08:40

目前這是一個尚未公開的問題（懶得查找數字），數百人已經評論過。沒有從GitHub返回的話:( – abalter 2016-03-14 19:12:12

當你在你的項目的wiki中，有一個鏈接添加自定義側邊欄。點擊那個。

Enter image description here

現在您有編輯，你可以編輯任何其他Markdown一頁一頁。要製作目錄，您必須手動完成。沒有自動化方法（截至2014年8月）。因此，例如：

# My menu 
* [Home][home] 
* [Technical documentation][techdocs] 
* [User manual][usermanual] 

[home]: https://github.com/myproject/wiki/Home 
[techdocs]: https://github.com/myproject/wiki/Technical-documentation 
[usermanual]: https://github.com/myproject/wiki/User-manual

來源

2014-08-14 09:17:17 Pithikos

我剛剛創建a Python script生成基於維基git的文件夾結構和頁面在GitHub上的_Sidebar.md的指數。

來源

2015-11-26 12:47:23

我已經實現了NPM模塊github-wiki-sidebar幫助GitHub的用戶能夠輕鬆地創建和維護工具欄菜單。

源和結果：

源頁面（如顯示在維基管理員）：

Home 
Installation 
Roadmap 
Usage 
Usage: Command line modifiers 
Usage: Init Mode

結果（定製按順序）：

前的要求：

克隆你的當地的github維基庫（顯示在維基UI的右下）

安裝GitHub的維基 - 側邊欄

git clone <https://github.com/<username>/<my-project-name>.wiki.git 
npm install -g github-wiki-sidebar

創建/更新您的維基菜單：

在你的github上創建新的頁面/重命名頁面。COM維基管理員

在您的維基庫文件夾本地GitHub的維基 - 側邊欄的腳本執行

cd /path/to/<my-project-name>.wiki 
# this fetches latest changes, generates sidebar file (_Sidebar.md) and pushes changes to github 
github-wiki-sidebar --git-push

的模塊允許降價輸出，包括項目的排序，分類分離器，模板的定製菜單，鏈接和其他的格式。

來源

2017-12-11 12:49:00 adtanasa

GitHub Wiki中的ToC或邊欄

回答

相關問題