web-dev-qa-db-ja.com

GitHub Wikiの目次またはサイドバー

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

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

これは、ページに自動的にあるヘッダーに基づいているのが最適です。

これらのリンクはすべて言及していますが、その方法は示していません。

githubwiki
79
wolle

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

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

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

Also：_Sidebar.mdは、すべてのページでグローバルです。ウィキをフォルダに整理する必要があるため、ページごとに異なるサイドバーを定義できます。

24
wolle

ソリューションは機能しますが、GitHubのWebインターフェイスを使用して簡単に実行できます。 _Sidebarおよび/または_Footerという名前のページを簡単に作成できます。

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

Edit元の記事はなくなっており、キャッシュで見つけることができないため、リンクを更新しました。

76
nicerobot

プロジェクトの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
22
Pithikos

元の質問は、サイドバー（簡単、回答で解決済み）または実際の目次（回答なし）の作成に関するものでした。

私が言えることの1つは、gollum 2.1 wiki構文では[[_TOC_]]タグですが、GitHub wikiはそれを認識しません（まだ？）。

10
mark

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

基本的に、_footer.extおよび_sidebar.extページコンテンツを含むディレクトリ内。

4
seandavi

作成したのは a Python script Wiki gitのフォルダー構造とページに基づいてGitHubの_Sidebar.mdにインデックスを生成します。

Enter image description here

3
Christopher Mueller

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.com wiki adminで新しいページを作成する/ページの名前を変更する

  • 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

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

2
adtanasa