ここを見ると:http://en.wikipedia.org/wiki/Stack_Overflow
小さな「コンテンツ」セクションがあることに気付くでしょう。リンクの 1 つをクリックすると、ページの特定のセクションに移動します。
GitHub wiki でこれを行うにはどうすればよいですか? Markdown または彼らが使用するものは何ですか?
ここを見ると:http://en.wikipedia.org/wiki/Stack_Overflow
小さな「コンテンツ」セクションがあることに気付くでしょう。リンクの 1 つをクリックすると、ページの特定のセクションに移動します。
GitHub wiki でこれを行うにはどうすればよいですか? Markdown または彼らが使用するものは何ですか?
Visual Studio Codeを使用している場合は、任意の .md ファイルの TOC を瞬時に作成できるMarkdown All in Oneという使いやすい拡張機能があります。
コマンド パレット ( ) を開くだけCtrl-Shift-P
->Markdown: Create Table of Contents
追加のヒントとして、次を使用して「保存時の自動 TOC 更新」をオフにすることをお勧めします。
"markdown.extension.toc.updateOnSave": false,
Visual Studio の設定 (コマンド パレット -> 設定: 設定を開く (JSON))。
考えられる (半自動化された) 解決策の 1 つは、Eugene Kalinin のgithub-markdown-toc
. このツールは基本的にREADME.md
ファイルを処理し、 の見出しを切り出して#
TOC を作成します。
スクリプトにフィードREADME.md
します (Eugene の に記載されているようにREADME.md
)
猫のREADME.md | バッシュ github-markdown-toc
生成された TOC をカット アンド ペーストし、README.md
ファイルの先頭に配置します
このbash
実装は Linux でのみ機能することに注意してください (私が知る限り)。
補足として、golang の実装があり、おそらく作業を行うのが面倒です。
Perl の上に実装されたもう 1 つの TOC マークダウン関連ツール (Linux/Git-for-Windows には常に付属しており、オプションで Cygwin にも付属しており、追加のパッケージへの依存関係はありません)
https://github.com/ildar-shaimordanov/git-markdown-toc
私のツールは、他の人が上で言及した ekalinin/git-markdown-toc と同様またはほぼ同様に機能すると思います。彼のツールは私のシステムには存在しない Go-Lang として実装されているため、私は tham を比較したことはありません。私のスクリプトの主な目標は、TOC をローカルに作成する際の優れたソリューションを提供することです。外部ホストなどへの接続は一切なく、ローカル ファイル (デフォルトでは README.md) のみを読み取り、TOC を作成して埋め込みます。ファイル。