私は大きなMarkdown文書を書いています。文書のさまざまな場所へのリンクを提供する種類の目次を最初に配置したいと考えています。これどうやってするの?
使ってみた
[a link](# MyTitle)
MyTitle
ドキュメント内のタイトルはどこにあり、これは機能しませんでした。
私は大きなMarkdown文書を書いています。文書のさまざまな場所へのリンクを提供する種類の目次を最初に配置したいと考えています。これどうやってするの?
使ってみた
[a link](# MyTitle)
MyTitle
ドキュメント内のタイトルはどこにあり、これは機能しませんでした。
回答:
でpandoc、このオプションを使用する場合--toc
HTMLを生成するには、目次はセクションへのリンク、およびセクション見出しから内容のテーブルに戻って生成されます。これは、LaTeX、rtf、rstなど、他の形式のpandoc書き込みと同様です。したがって、コマンド
pandoc --toc happiness.txt -o happiness.html
マークダウンのこのビット:
% True Happiness
Introduction
------------
Many have posed the question of true happiness. In this blog post we propose to
solve it.
First Attempts
--------------
The earliest attempts at attaining true happiness of course aimed at pleasure.
Soon, though, the downside of pleasure was revealed.
これは、htmlの本文として生成されます。
<h1 class="title">
True Happiness
</h1>
<div id="TOC">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#first-attempts">First Attempts</a>
</li>
</ul>
</div>
<div id="introduction">
<h2>
<a href="#TOC">Introduction</a>
</h2>
<p>
Many have posed the question of true happiness. In this blog post we propose to solve it.
</p>
</div>
<div id="first-attempts">
<h2>
<a href="#TOC">First Attempts</a>
</h2>
<p>
The earliest attempts at attaining true happiness of course aimed at pleasure. Soon, though, the downside of pleasure was revealed.
</p>
</div>
git clone
に、おそらくtmbundleディレクトリの最下位または最外部に-edする必要があります~/Library/Application\ Support/TextMate/Bundles
。
-1
、IDの最初の繰り返しに-2
等秒に
Githubは、ヘッダーからアンカータグを自動的に解析します。したがって、次のことができます。
[Custom foo description](#foo)
# Foo
上記の場合、Foo
ヘッダーは次の名前のアンカータグを生成しましたfoo
注:#
すべての見出しサイズに1つのみ#
、アンカー名とアンカー名の間にスペースはありません。アンカータグ名は小文字で、マルチワードの場合はダッシュで区切る必要があります。
[click on this link](#my-multi-word-header)
### My Multi Word Header
箱から出してpandoc
でも動作します。
[just](#like-this-one)
。
## Foo
は、[これはFooへの私のリンクです](#foo)...を試してください:単一のハッシュ、ハッシュと小文字のケバブケース名の
実験して、私は使用している解決策を見つけました<div…/>
が、明白な解決策は、ページ内の好きな場所に独自のアンカーポイントを配置することです。
<a name="abcde">
以前と
</a>
「リンク」したい行の後。次に、次のようなマークダウンリンク:
[link text](#abcde)
ドキュメントのどこにでも移動できます。
<div…/>
解決策は、単に追加するには、「ダミー」部門を挿入するid
プロパティを、これはページ構造に潜在的に破壊的であるが、<a name="abcde"/>
解決策は非常に無害であるべき。
(PS:アンカーを入れてOKかもしれない中で次のようにあなたは、にリンクしたい行:
## <a name="head1">Heading One</a>
しかし、これはMarkdownがこれをどのように扱うかに依存します。たとえば、Stack Overflowの回答フォーマッターはこれで満足です!)
## headers
。
<div/>
以下の数行が含まれていると影響を受けることがわかりました。代わりに、リンクするテキストを完全なdiv
タグ句でラップする必要があり、実際のHTMLを使用して動作を最初から再指定する必要があります。ブー。
これは古いスレッドである可能性がありますが、Githubの
マークダウンで内部ドキュメントリンクを作成するには、次のように使用します(注:小文字の#title)
# Contents
- [Specification](#specification)
- [Dependencies Title](#dependencies-title)
## Specification
Example text blah. Example text blah. Example text blah. Example text blah.
Example text blah. Example text blah. Example text blah. Example text blah.
Example text blah. Example text blah. Example text blah. Example text blah.
Example text blah. Example text blah.
## Dependencies Title
Example text blah. Example text blah. Example text blah. Example text blah.
Example text blah. Example text blah. Example text blah. Example text blah.
Example text blah. Example text blah. Example text blah. Example text blah.
Example text blah. Example text blah.
良い質問がなされたので、私の回答を編集しました。
内部リンクは、使用して、任意のタイトルの大きさにすることができる- 、#
、、##
私は下に...簡単な例を作成し
https://github.com/aogilvie/markdownLinkTest###
####
(#dependencies-title)
はGithubマークダウンにこれが内部リンクであることを伝えます。次のテキストは、任意のタイトルサイズにすることができます。これが私が作ったテストの例です... https://github.com/aogilvie/markdownLinkTest
pandocマニュアルでは、識別子を使用してヘッダーにリンクする方法について説明しています。他のパーサーによるサポートについては確認しませんでしたが、githubでは動作しないことが報告されています。
識別子は手動で指定できます。
## my heading text {#mht}
Some normal text here,
including a [link to the header](#mht).
または、自動生成された識別子(この場合は#my-heading-text
)を使用できます。どちらもpandocマニュアルで詳細に説明されています。
注:これは、HTML、LaTex、ConTeXt、Textile、またはAsciiDocに変換する場合にのみ機能します。
屋がこれまでに取得した場合心に留めておくべきいくつかの追加のもの空想を屋にナビゲートすることを見出し内のシンボルと...
# What this is about
------
#### Table of Contents
- [About](#what-this-is-about)
- [⚡ Sunopsis](#9889-tldr)
- [:gear: Grinders](#it-grinds-my-gears)
- [Attribution]
------
## ⚡ TLDR
Words for those short on time or attention.
___
## It Grinds my :gear:s
Here _`:gear:`_ is not something like ⚙ or ⛭
___
## ⛤ Attribution
Probably to much time at a keyboard
[Attribution]: #9956-attribution
...のようなもの#
、;
、&
、と:
の見出しの文字列の中には、一般的に/無視してストライプの代わりに、エスケープ、および1も使用することができますされている引用簡単に素早く利用するために、スタイルのリンクを。
ノート
GitHubは、
:word:
コミット、readmeファイルなどの構文をサポートしています。要点を using'emが重要である場合(rxaviersからの)。そして、ほとんどすべての場所で、10進数または16進数を最新のブラウザーに使用できます。w3schoolsのチートシートは、特にCSS やシンボル付きの疑似要素を使用する方がスタイルに合っている場合は、非常に便利です。
::before
::after
万が一、見出し内の画像やその他のリンクがどのように解析されて、 id
...
- [Imaged](#alt-textbadge__examplehttpsexamplecom-to-somewhere)
## [![Alt Text][badge__example]](https://example.com) To Somewhere
[badge__example]:
https://img.shields.io/badge/Left-Right-success.svg?labelColor=brown&logo=stackexchange
"Eeak a mouse!"
MarkDownレンダリングは場所によって異なるため、次のようなものです...
## methodName([options]) => <code>Promise</code>
... GitHubには次の要素があります id
ます...
id="methodnameoptions--promise"
... バニラの衛生が結果としてid
...
id="methodnameoptions-codepromisecode"
...その書き込みを意味するか、テンプレートから値下げファイルをコンパイルのいずれか1つの方法を対象とする必要がslugifeing、または様々なために構成およびスクリプトロジックを追加する巧妙な場所は、見出しのテキストをきれいにしたいということな方法。
この質問は、マークダウンの実装によって異なる答えを持っているようです。
実際、公式のMarkdownドキュメントはこのトピックについては触れていません。
このような場合、およびポータブルソリューションが必要な場合は、HTMLを使用できます。
ヘッダーの前、または同じヘッダー行で、HTMLタグを使用してIDを定義します。
例えば:<a id="Chapter1"></a>
これはコードに表示されますが、レンダリングされたドキュメントには表示されません。
完全な例(オンラインおよび編集可能)はこちらを参照してください。
## Content
* [Chapter 1](#Chapter1)
* [Chapter 2](#Chapter2)
<div id="Chapter1"></div>
## Chapter 1
Some text here.
Some text here.
Some text here.
## Chapter 2 <span id="Chapter2"><span>
Some text here.
Some text here.
Some text here.
この例をテストするには、コンテンツリストと最初の章の間にスペースを追加するか、ウィンドウの高さを低くする必要があります。
また、IDの名前にスペースを使用しないでください。
## Chapter 1
その上に開いた線が必要です。(2)。リンクが機能しない...
<span id="Chapter1"><span>
Markdown仕様にはそのようなディレクティブはありません。ごめんなさい。
GitlabはGitLab Flavored Markdown(GFM)を使用します
ここで「すべてのMarkdownでレンダリングされたヘッダーは自動的にIDを取得します」
マウスを使用して次のことができます。
右クリックでリンクをコピーして保存
たとえば、README.mdファイルにはヘッダーがあります。
## series expansion formula of the Boettcher function
リンクを与える:
プレフィックスを削除できるので、ここのリンクは単純です
file#header
ここでの意味:
README.md#series-expansion-formula-of-the-boettcher-function
今では次のように使用できます:
[series expansion formula of the Boettcher function](README.md#series-expansion-formula-of-the-boettcher-function)
手動で行うこともできます。スペースをハイフン記号に置き換えます。
ライブ例はこちら
MultiMarkdownがコメントのオプションとして言及されたので。
でMultiMarkdown内部リンクの構文は単純です。
ドキュメントの見出しについては、この形式で見出し名[heading][]
を指定するだけで、内部リンクが作成されます。
詳細については、MultiMarkdown-5相互参照をご覧ください。
クロスリファレンス
よくリクエストされた機能は、Markdownが外部リンクを処理するのと同じくらい簡単にドキュメント内リンクを自動的に処理する機能でした。この目的のために、「Some Text」という名前のヘッダーが存在する場合、[Some Text] []をクロスリンクとして解釈する機能を追加しました。
例として、[メタデータ] []は、#メタデータ(または##メタデータ、###メタデータ、####メタデータ、#####メタデータ、######メタデータ)に移動します。
あるいは、選択したオプションのラベルを含めて、複数のヘッダーが同じタイトルを持つ場合を明確にすることができます。
###概要[MultiMarkdownOverview] ##
これにより、[MultiMarkdownOverview]を使用してこのセクションを具体的に参照することができ、Overviewという別のセクションを参照することはできません。これは、atxスタイルまたはsettextスタイルのヘッダーで機能します。
ヘッダーで使用されているのと同じIDを使用してアンカーを既に定義している場合は、定義されたアンカーが優先されます。
ドキュメント内のヘッダーに加えて、相互参照にも使用できる画像や表のラベルを提供できます。