1. ホーム
  2. github

[解決済み] GitHub Wiki の ToC とサイドバー

2023-02-17 21:40:19

質問

GitHub WikiでToCやサイドバーメニューを作成するにはどうしたらよいですか?

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

自動的にページ内にあるヘッダを元にするのが一番いいのですが。

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

  • https://gist.github.com/379469 - JavaScriptハック
  • https://github.com/blog/774-git-powered-wikis-improved - GitHubで言及されています。

    GitHubのWikiには、フッターやサイドバーのための、あまり文書化されていない機能があります。 git ベースの Wiki 作者にはおなじみのものです。新しいWikiエディタでは、ウェブベースの限定的な編集が可能です。 フッターとサイドバーの編集ができるようになりました。

どのように解決するのですか?

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

  1. GitHubのwikiをクローンします。(wikiにGitの項目があります。 wiki的なコードをチェックアウトすることができます)。
  2. 作成する _Sidebar.md
  3. 通常のWikiページでは [[link]] でサイドバーを表示します。
  4. コミットしてGitHubにプッシュバックする

この作業はめんどくさいです。この「ゴラム」Wikiが受け入れられているのが不思議なくらいです。

また _Sidebar.md は、したがって はすべてのページに対してグローバルです。 . 私はwikiをフォルダに整理しなければならないので、異なるページに対して異なるサイドバーを定義することができます。