GitHub wikiである種の目次を作成するにはどうすればよいですか？

Question

ここを見ると： http://en.wikipedia.org/wiki/Stack_Overflow

小さな「コンテンツ」セクションがあることに気付くでしょう。リンクのいずれかをクリックすると、ページの特定のセクションに移動します。

GitHub wikiでこれを行うにはどうすればよいですか？マークダウンなど、彼らが使用するものは何ですか？

Answer 1

Markdown Cheatsheet の目次でうまく示されています。

##### Table of Contents  
[Headers](#headers)  
[Emphasis](#emphasis)  
...snip...    
<a name="headers"/>
## Headers

GitHub Markdownファイルのヘッダーにカーソルを合わせると、左側に簡単な小さなリンクが表示されます。そのリンクを使用することもできます。そのリンクの形式は<project URL#<header name>。 <header name>はすべて小文字でなければなりません。

Answer 2

可能な（半自動化された）ソリューションの1つは、ユージーンカリーニンのgithub-markdown-toc。このツールは、基本的にREADME.mdファイルとスナーフ出力#の見出しで目次を作成します。

1. スクリプトをダウンロード https://github.com/ekalinin/github-markdown-toc

2. README.mdスクリプトへ（ユージンのREADME.md）

   cat README.md | bash github-markdown-toc

3. 生成されたTOCをカットアンドペーストして、README.mdファイル

このbashの実装はLinuxでのみ動作することに注意してください（私が知る限り）。

補足として、golang 実装 があり、おそらく動作するのが面倒です。

Answer 3

https://github.com/jonschlinkert/markdown-toc

• git clone your-repo.wiki.git（.wiki 直前 .git wikiを複製する
• npm i -g markdown-toc
• 挿入<!-- toc -->（大文字と小文字が区別されます）ウィキのマークダウン
• markdown-toc -i my-wiki-markdown.md（-iはその場で編集します）
• 利益

---

更新：多分 https://github.com/thlorenz/doctoc がより人気があります。

Answer 4

現在、 不可能 マークダウン構文（.md）。非公式 目次の目次の自動生成についての議論 は、README.mdいくつかのアイデアをリストします。

ただし、次のような他の回避策があります。

• この comment からの提案に従って、代わりにAsciiDocを使用してください。例えば：

  :toc: macro
  :toc-title:
  :toclevels: 99
  # Title
  
  toc::[]
  
  ## A
  
  ### A2
  
  ## B
  
  ### B2
  

  littlebits/react-popover（README.adoc） 。

• オンライン コンテンツジェネレーターのテーブル （ raychenon/play-table-of-contents ）

• arthurhammer/github-toc -GitHubリポジトリに目次を追加するブラウザー拡張機能

Answer 5

Markdownに固執する立場にない場合は、次のようにすることができます。

• on GitHub/wiki：switch Markdown to MediaWiki 。つかいます __TOC__構文。 サンプル を参照してください。
• on GitHub/repo：switch Markdown to AsciiDoc つかいます :toc:構文。 demo を参照してください。

ただし、MarkdownGitHub/repoのファイルを使用すると、 GitHub Pagesウィキペディア

• Jekyllが有効になっている場合、 を使用してGitHub Pagesを生成しますKramdown デフォルトで
• KramdownにはTable Of Content。つかいます {:toc}構文。 説明 を参照してください。

Answer 6

GithubはTOCを直接使用できないため、他の選択肢があります。

オンラインツールを介してTOCを自動的に生成できます：

GitHub MarkdownまたはWiki Onlineから目次を生成する

またはローカルツール：

github-markdown-toc

Answer 7

ヘッダーのtocを生成する編集モード「MediaWiki」を選択できます。

== First ==

== Second ==

Answer 8

私への最も簡単な解決策は（私は常にnode.jsサーバーがインストールされており、npmにはnpxがあるので） npx markdown-toc を実行することです。このタスクに対する最も一般的なソリューションの1つであるようです。

ls
cat <<EOF >> test.md | tee 
## Table of Contents

<!-- toc -->
- old toc 1
- old toc 2
- old toc 3
<!-- tocstop -->

## abc
This is a b c.

## xyz
This is x y z.
EOF
ls
cat test.md
npx markdown-toc -i test.md
cat test.md

出力：