Piszę duży dokument Markdown i chciałbym umieścić na początku swego rodzaju spis treści, który będzie zawierał łącza do różnych lokalizacji w dokumencie. W jaki sposób mogę to zrobić?

Próbowałem użyć

[a link](# MyTitle)

gdzie MyTitlejest tytuł w dokumencie i to nie działało.

W pandoc , jeśli użyjesz opcji --tocdo tworzenia html, spis treści zostanie utworzony z linkami do sekcji i z powrotem do spisu treści z nagłówków sekcji. Podobnie jest z innymi formatami zapisywanymi przez pandoc, takimi jak LaTeX, rtf, rst itp. Tak więc z poleceniem

pandoc --toc happiness.txt -o happiness.html

ten kawałek zniżki:

% 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.

da to jako treść 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>

Github automatycznie analizuje tagi kotwicy z twoich nagłówków. Możesz więc wykonać następujące czynności:

[Custom foo description](#foo)

# Foo

W powyższym przypadku Foonagłówek wygenerował tag zakotwiczenia o nazwiefoo

Uwaga : tylko jeden #dla wszystkich rozmiarów nagłówków, bez spacji #i nazwy kotwicy, zakotwiczenia, nazwy znaczników zakotwiczenia muszą być pisane małymi literami i oddzielane myślnikami, jeśli d -multi

[click on this link](#my-multi-word-header)

### My Multi Word Header

Aktualizacja

Działa również po wyjęciu z pudełka pandoc.

Eksperymentując, znalazłem rozwiązanie wykorzystujące, <div…/>ale oczywistym rozwiązaniem jest umieszczenie własnego punktu kontrolnego na stronie, gdziekolwiek chcesz, w ten sposób:

<a name="abcde">

przed i

</a>

po linii, którą chcesz „połączyć”. Następnie link przeceny, taki jak:

[link text](#abcde)

zabierze Cię tam gdziekolwiek w dokumencie.

<div…/>Rozwiązanie wstawia „atrapę” podział prostu dodać idwłaściwość, a to potencjalnie uciążliwy do struktury strony, ale<a name="abcde"/> rozwiązanie powinno być zupełnie nieszkodliwe.

(PS: Umieszczenie kotwicy w linii, do której chcesz utworzyć łącze, może być w następujący sposób:

## <a name="head1">Heading One</a>

ale to zależy od tego, jak potraktuje to Markdown. Zaznaczam na przykład, że formater odpowiedzi przepełnienia stosu jest z tego zadowolony!)

Może to być nieaktualny wątek, ale do tworzenia wewnętrznych linków do dokumentów w znacznikach w Github użyj ...
(UWAGA: małe litery #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. 

Zadano dobre pytanie, więc zredagowałem swoją odpowiedź;

Można utworzyć łącze wewnętrzne do dowolnego rozmiaru tytułu, używając - # , ##, ###, #### I stworzył krótki przykład poniżej ... https://github.com/aogilvie/markdownLinkTest

tak, Markdown to robi, ale musisz podać nazwę kotwicy <a name='xyx'> .

pełny przykład

to tworzy link
[tasks](#tasks)

w dalszej części dokumentu utworzysz nazwaną kotwicę (jakkolwiek to się nazywa).

<a name="tasks">
   my tasks
</a>

pamiętaj, że możesz również owinąć go wokół nagłówka.

<a name="tasks">
### Agile tasks (created by developer)
</a>

Podręcznik pandoc wyjaśnia, jak połączyć się z nagłówkami, używając ich identyfikatora. Nie sprawdziłem obsługi tego przez inne parsery, ale zgłoszono, że nie działa na github .

Identyfikator można podać ręcznie:

## my heading text {#mht}
Some normal text here,
including a [link to the header](#mht).

lub możesz użyć automatycznie wygenerowanego identyfikatora (w tym przypadku #my-heading-text). Oba są szczegółowo wyjaśnione w podręczniku pandoc .

UWAGA : Działa to tylko podczas konwersji na HTML , LaTex , ConTeXt , Textile lub AsciiDoc .

Niektóre dodatkowe rzeczy, o których warto pamiętać, jeśli ya kiedykolwiek fantazję z symboli w pozycjach, które ya chcą, aby przejść do ...

# 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

... takie rzeczy jak #, ;, &, i :w pozycji łańcuchy są zazwyczaj są ignorowane / paski zamiast uciec, a można też użyć cytat łączy styl do szybkiego wykorzystania łatwiejsze.

Notatki

GitHub obsługuje :word:składnię w commits, plikach readme itp. Patrz gist commits (z rxaviers), jeśli użycie'em jest tam interesujące.

I prawie wszędzie indziej można używać dziesiętnych lub szesnastkowych w nowoczesnych przeglądarkach; ściągawka z w3schools jest bardzo poręczna , szczególnie jeśli używasz CSS ::beforelub ::afterpseudoelementów z symbolami, to bardziej twój styl.

Punkty bonusowe?

Na wypadek, gdyby ktoś zastanawiał się, w jaki sposób obrazy i inne linki w nagłówku są przetwarzane w 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!"

Ostrzeżenia

Renderowanie MarkDown różni się w zależności od miejsca, więc rzeczy takie jak ...

## methodName([options]) => <code>Promise</code>

... na GitHub będzie miał element idtaki jak ...

id="methodnameoptions--promise"

... gdzie jako wanilia sanitarna spowodowałaby id...

id="methodnameoptions-codepromisecode"

... co oznacza, że ​​pisanie lub kompilowanie plików MarkDown z szablonów wymaga albo ukierunkowania jednego sposobu na slugifeing , albo dodania konfiguracji i logiki skryptowej dla różnych sprytnych sposobów, w które lubią czyścić tekst nagłówka.

Uniwersalne rozwiązania

To pytanie wydaje się mieć inną odpowiedź w zależności od realizacji obniżki.
W rzeczywistości oficjalna dokumentacja Markdown milczy na ten temat.
W takich przypadkach i jeśli potrzebujesz przenośnego rozwiązania, możesz użyć HTML.

Przed dowolnym nagłówkiem lub w tym samym wierszu nagłówka zdefiniuj identyfikator za pomocą tagu HTML.
Na przykład:<a id="Chapter1"></a>
Zobaczysz to w kodzie, ale nie w renderowanym dokumencie.

Pełny przykład:

Zobacz pełny przykład (online i edytowalny) tutaj .

## 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.

Aby przetestować ten przykład, musisz dodać dodatkową przestrzeń między listą treści a pierwszym rozdziałem lub zmniejszyć wysokość okna.
Nie używaj również spacji w nazwie identyfikatorów.

Nie ma takiej dyrektywy w specyfikacji Markdown. Przepraszam.

Gitlab używa GitLab Flavored Markdown (GFM)

Tutaj „wszystkie nagłówki renderowane przez Markdown automatycznie otrzymują identyfikatory”

Można użyć myszy do:

• przesuń mysz nad nagłówek
• najedź myszką na selektor najechania, który staje się widoczny po lewej stronie od nagłówka

• skopiuj i zapisz link klikając prawym przyciskiem myszy

  Na przykład w pliku README.md mam nagłówek:

## series expansion formula of the Boettcher function

który daje link:

https://gitlab.com/adammajewski/parameter_external_angle/blob/master/README.md#series-expansion-formula-of-the-boettcher-function

Prefiks można usunąć, więc link tutaj jest prosty

file#header

co tutaj oznacza:

README.md#series-expansion-formula-of-the-boettcher-function

Teraz może być używany jako:

[series expansion formula of the Boettcher function](README.md#series-expansion-formula-of-the-boettcher-function)

Można to również zrobić ręcznie: zastąp spacje znakiem łącznika.

Przykład na żywo jest tutaj

Przy użyciu kramdown wydaje się, że działa to dobrze:

[I want this to link to foo](#foo)
....
....
{: id="foo"}
### Foo are you?

Widzę, że wspomniano o tym

[foo][#foo]
....
#Foo

działa wydajnie, ale ta pierwsza może być dobrą alternatywą dla elementów oprócz nagłówków lub nagłówków z wieloma słowami.

Ponieważ MultiMarkdown został wymieniony jako opcja w komentarzach.

W MultiMarkdown składnia łącza wewnętrznego jest prosta.

W przypadku dowolnego nagłówka w dokumencie wystarczy podać nazwę nagłówka w tym formacie [heading][] aby utworzyć łącze wewnętrzne.

Przeczytaj więcej tutaj: MultiMarkdown-5 Odsyłacze .

Odsyłacze

Często żądaną funkcją była możliwość automatycznego, aby Markdown automatycznie obsługiwał łącza wewnątrz dokumentu tak łatwo, jak obsługiwał łącza zewnętrzne. W tym celu dodałem możliwość interpretacji [Some Text] [] jako linku, jeśli istnieje nagłówek o nazwie „Some Text”.

Na przykład [Metadane] [] zabierze Cię do # Metadanych (lub dowolnego z ## Metadata, ### Metadata, #### Metadata, ##### Metadata, ###### Metadata).

Możesz też dołączyć opcjonalną etykietę, aby ułatwić jednoznaczne przypadki, w których wiele nagłówków ma ten sam tytuł:

### Przegląd [MultiMarkdownOverview] ##

Pozwala to na użycie [MultiMarkdownOverview] w celu odniesienia się konkretnie do tej sekcji, a nie do innej sekcji o nazwie Przegląd. Działa to z nagłówkami w stylu atx lub settext.

Jeśli już zdefiniowałeś kotwicę przy użyciu tego samego identyfikatora, który jest używany przez nagłówek, wtedy zdefiniowana kotwica ma pierwszeństwo.

Oprócz nagłówków w dokumencie możesz także udostępnić etykiety dla obrazów i tabel, które mogą być następnie wykorzystane do odsyłaczy.

Więcej spinów na <a name="">lewie:

<a id="a-link"></a> Title
------

#### <a id="a-link"></a> Title (when you wanna control the h{N} with #'s)

Oprócz powyższych odpowiedzi

Podczas ustawiania opcji number_sections: truew nagłówku YAML:

number_sections: TRUE

RMarkdown automatycznie ponumeruje twoje sekcje.

Aby odwołać się do tych automatycznie ponumerowanych sekcji, po prostu umieść w pliku R Markdown:

[My Section]

Gdzie My Section jest nazwa sekcji

Wydaje się, że działa to niezależnie od poziomu sekcji:

# My section

## My section

### My section