2013-08-15 14 views
27

ここをクリックすると:http://en.wikipedia.org/wiki/Stack_Overflow 小さな「コンテンツ」セクションがあります。リンクの1つをクリックすると、ページの特定のセクションに移動します。GitHub wikiで何らかの種類のコンテンツテーブルを作成するにはどうすればよいですか?

GitHub wikiでこれを行うにはどうすればよいですか? Markdownを使用するか、それとも何を使用しますか?

+2

関連が、正確な複製ではない、それは、より多くの詳細に立ち入り:http://stackoverflow.com/q/9721944/2291 –

答えて

37

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

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

あなたはGitHubの値下げファイルのヘッダーの上に置くと、あなたはそれの左側にシンプルで小さなリンクが表示されます、あなたもそのリンクを使用することができます。そのリンクのフォーマットは<project URL#<header name>です。 <header name>はすべて小文字でなければなりません。

+7

確かにMediaWikiの_ _ _ _ TOCのようにそれを自動生成する方法はありますか? –

+4

@ LB--:GitHub wikiページを編集し、 "編集スタイル"ドロップダウンを "MediaWiki"に変更すると、MediaWiki '__TOC__'を直接使うことができます。明らかに、基礎となる自動生成ロジックが存在します。しかし、その機能はMarkdown編集スタイルでは公開されていないようです。非常に残念です。すべての機能要求を送信してみましょう。多分それをオンにするでしょう。 –

+2

私はそこにある "基礎となる自動生成ロジック"を唱えません。異なる「レンダリングスタイル」が異なるレンダラーを通過するように見えます。それでも、これはMD版では大変人気があり、追加するのは難しくありません。 –

6

可能な(半自動)解決策の1つは、ユージーン・カリニンのgithub-markdown-tocです。このツールは本質的にあなたのREADME.mdファイルを切り抜き、#の見出しを驚かせて目次を作成します。

  1. スクリプトhttps://github.com/ekalinin/github-markdown-toc
  2. フィードをダウンロードREADME.mdスクリプトに

    猫README.md(ユージンのREADME.mdに述べたように)|バッシュgithubの-値下げ-TOC

  3. カットし、生成されたTOCを貼り付け、このbash実装は唯一の(私が言うことができるものから)Linux上で動作することをごREADME.mdファイル

ノートの一番上に置きます。

ゴールウェイimplementationがあり、おそらく動作するのは面倒です。

4

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

  • git clone your-repo.wiki.git(あなたのwikiの値下げに挿入<!-- toc -->(大文字と小文字を区別)
  • ウィキのクローンを作成するために、右.git
  • markdown-toc -i my-wiki-markdown.mdnpm i -g markdown-toc
  • .wikiを追加(-iはそれを編集します場所)
  • 利益
1

現在、マークダウン構文(.md)を使用してこれを行うのはnot possibleです。いくつかのアイデアをリストアップしたREADME.mdのようなレンダリングされたマークダウンファイルには、進行中の非公式のdiscussion about automatically generating table of contents TOCがあります。

1

GitHubのレポに目次を追加するブラウザ拡張機能、例えば

== First == 

== Second == 
+0

真。例については、https://github.com/bitcoin/bips/blob/master/bip-0174.mediawikiを参照してください。 – Agis

関連する問題