GitHubWikiのToCまたはサイドバー


87

GitHub Wikiで目次またはサイドバーメニューを作成するにはどうすればよいですか?

私はそれについていくつかの言及を見ました、そしてゴラムはバックエンドがそれをサポートしているようです、しかし私は現在のGitHubプロジェクトでそれをどのように行うのですか?

これは、ページに自動的にあるヘッダーに基づいている必要があります。

これらのリンクはすべてそれについて言及していますが、それを行う方法を示していません:


3
私はGitHubWikifierを開発しました。これは、必要になるすべての目次を生成する、コミット前のGitフックです。コンテンツを書いて、それを引き継ぐだけです。チェックする価値があるかもしれません。github.com/kuroir/GitHub-Wikifier
MarioRicalde 2012


@MarioRicaldeのコードはgithub.com/hybridgroup/GitHub-Wikifierに
Jonny

回答:


76

ソリューションは機能しますが、GitHubのWebインターフェイスを使用してそれを行う簡単な方法があります。_Sidebarおよび/またはという名前のページを作成するだけ_Footerです。

マルチレベルのGithubWikiサイドバーメニュービルダーの詳細な手順を参照してください。

編集元の記事がなくなり、キャッシュに見つからないため、リンクを更新しました。


7
@CodeSherpaでアクセス可能でhttps://github.com/[user]/[repo]/wiki/_Sidebar/_edithttps://github.com/[user]/[repo]/wiki/_Footer/_edit
nicerobot 2013年

1
この記事は素晴らしかったですが、ウィキのURLを取得する方法について誤った(または古くなった)情報を提供しています。私と同じように迷子になった場合は、URLhttps://github.com/<username>/<projectname>.wiki.gitまたはSSHを使用する必要がありますgit@github.com:<username>/<projectname>.wiki.git
nightOwl888 2014

1
これらの詳細な手順はかなり貧弱です。とは何[[link]]ですか?そこにURLを入力すると、URL全体が表示されます。
ピティコス2014

3
@PithikosそれはGithubMarkdownが話すことです。Markdownを教えるための指示はありません。彼らはサイドバーを説明するためにあります。
nicerobot 2014

2
@nicerobotと何かを説明する最良の方法は、具体的な例を使用して..です
Pithikos

26

プロジェクトのwikiにいるときは、[カスタムサイドバーを追加する]リンクがあります。それをクリックします。

ここに画像の説明を入力してください

これで、他の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

25

はい。私がこれを正しく理解しているかどうか見てみましょう:

  1. GitHubwikiのクローンを作成します。(ウィキにはGitセクションがあります。ウィキのようなコードをチェックアウトできます。)
  2. 作成する _Sidebar.md
  3. 通常のWikiページで[[link]]は、サイドバーに使用します
  4. コミットしてGitHubにプッシュバック

このプロセスはお尻の痛みです。この「ゴラム」ウィキが受け入れられていることに驚いています。

また: _Sidebar.mdしたがって、すべてのページに対してグローバルです。Wikiをフォルダーに整理する必要があるため、ページごとに異なるサイドバーを定義できます。


2
ドキュメントによると、フォルダごとに異なるサイドバーを追加できます。「サイドバーは、ディレクトリ内のすべてのページと、独自のサイドバーファイルを持たないサブディレクトリに影響します。」参照:github.com/github/gollum
Subfuzion

10

元の質問は、サイドバー(簡単、回答で解決)または実際の目次(回答なし)の作成に関するものであったことに注意してください。

私が言えることの1つは、gollum 2.1 wiki構文では[[_TOC_]]タグが許可されているが、GitHub wikiはそれを認識しないということです(まだ?)。


4
運が良かったですか?これは、これらすべてのことが簡単に行われたTracから来たので、ひどくイライラします。
jooks 2013

「ページにあるヘッダーに基づいて自動的に」目次を作成する方法に関する元の質問に対するより良い答えは、現在GitHubWikiでは不可能だと思います。
avernet 2014

これは現在、何百人もの人々がコメントしている未解決の問題です(数を調べるのが面倒です)。GitHubからの返信はまだありません:(
abalter 2016年

2017-01-19の時点でこれを参照する主なGitHubの問題は次のとおりです。1。マークダウン-目次 2.自動生成された
ckib16

4

これはゴラムでREADME説明されていると思います。(ヘッダーとサイドバーのセクションを参照してください。)

基本的に、あなたが作る_footer.ext_sidebar.extページのコンテンツを含むディレクトリにあります。


2

npmモジュールgithub-wiki-sidebarを実装して、githubユーザーがサイドバーメニューを簡単に作成および保守できるようにしました。

ソースと結果:https//raw.githubusercontent.com/wiki/adriantanasa/github-wiki-sidebar/images/github-wiki-sidebar-generator.png

ソースページ(Wiki管理者に表示される):

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

結果(カスタマイズされた順序で):

前提条件:

  • github wikiリポジトリをローカルに複製します(Wiki UIの右下に表示されます)
  • github-wiki-sidebarをインストールします

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

Wikiメニューを作成/更新します。

  • github.comwiki管理者で新しいページを作成/ページの名前を変更します
  • wikiリポジトリフォルダーでgithub-wiki-sidebarスクリプトをローカルで実行します

    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
    

このモジュールでは、アイテムの順序、カテゴリセパレータ、メニューのテンプレート、リンクの形式など、マークダウン出力をカスタマイズできます。


0

GitHubは、ドキュメントの目次を自動生成します。

  1. Markdownの代わりにドキュメントタイプをAsciiDocにします。
  2. :toc:ドキュメントの先頭に挿入します。
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.