2013-08-15 19 views

Odpowiedz

37

Jest to ładnie przedstawione w Spisie treści Markdown Cheatsheet.

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

Jeśli po najechaniu na nagłówek w pliku Markdown GitHub, zobaczysz mały odnośnik proste do jego lewej strony, można też użyć tego linku. Format tego linku to <project URL#<header name>. Numer <header name> musi być pisany małymi literami.

+7

Z pewnością istnieje sposób, aby autogenerować go jak MediaWiki _ _ _ _ TOC? –

+4

@ LB--: Jeśli edytujesz stronę wiki GitHub i zmienisz "styl edycji" na "MediaWiki", możesz po prostu użyć MediaWiki '__TOC__' bezpośrednio. Najwyraźniej znajduje się tam podstawowa logika autogeneracji. Ale funkcjonalność nie wydaje się być widoczna w ich stylu edycji Markdown. Całkiem niefortunne. Niech wszyscy zaczną wysyłać prośby o dodanie funkcji i być może go włączą. –

+2

Oddaje mi się, że istnieje "podstawowa logika autogeneracji"; wygląda na to, że różne "style edycji" przechodzą przez różne renderery. Mimo to byłoby wspaniale mieć to w wersji MD, ponieważ jest to dość popularne i nie może być trudne do dodania. –

6

Jednym z możliwych (półautomatycznych) rozwiązań jest github-markdown-toc Eugene'a Kalinina. To narzędzie zasadniczo przerywa Twój plik README.md i wygłusza nagłówki # w celu utworzenia spisu treści.

  1. Pobierz skrypt https://github.com/ekalinin/github-markdown-toc
  2. karmić README.md do skryptu (jak wspomniano w Eugeniusza README.md)

    kota README.md | bash github-Przecena-toc

  3. Wytnij i wklej wygenerowany TOC i umieścić ją w górnej części pliku README.md

pamiętać, że ta realizacja bash działa tylko na Linuksie (z tego co mogę powiedzieć).

Na marginesie, istnieje golang implementation i jest to prawdopodobnie więcej kłopotów z podjęciem pracy.

1

Obecnie to not possible to zrobić za pomocą składni Markdown (.md). Trwa nieoficjalne przetwarzanie discussion about automatically generating table of contents TOC plików oznaczeń, takich jak README.md, które zawierają niektóre z pomysłów.

Jednakże istnieją pewne inne obejścia takich jak:

1

Można wybrać tryb edycji „Dyskusja”, która będzie generować TOC Dla nagłówków np

== First == 

== Second == 
+0

Prawda. Zobacz https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki na przykład. – Agis

Powiązane problemy