tag - ¿Cómo creo algún tipo de tabla de contenido en la wiki de GitHub?

git versioning

Question

Si miras aquí: http://en.wikipedia.org/wiki/Stack_Overflow

Notarás que hay una pequeña sección de "Contenido", si haces clic en uno de los enlaces, te enviará a una sección específica en la página.

¿Cómo hago esto en la wiki de GitHub? Con Markdown o lo que sea que usen?

Answer 1

Actualmente no es posible hacer eso usando la sintaxis de .md ( .md ). Existe una discusión no oficial en curso sobre la generación automática de tablas de contenido TOC en archivos de rebajas renderizados como README.md que enumera algunas de las ideas.

Sin embargo, hay algunas otras soluciones como, por ejemplo:

• Use AsciiDoc cambio según la sugerencia de esta suggestion . Por ejemplo:

  :toc: macro
  :toc-title:
  :toclevels: 99
  # Title
  ## A
  ### A2
  ## B
  ### B2

  Verifique el ejemplo en littlebits/react-popover ( README.adoc ) .

• Tabla en línea del generador de contenido ( raychenon/play-table-of-contents )

• arthurhammer/github-toc - extensión de navegador que agrega una tabla de contenidos a los repositorios de GitHub

Answer 2

Está muy bien demostrado en la Tabla de Contenido de la Hoja de Chequeo Markdown .

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

Si pasa el mouse sobre un Encabezado en un archivo GitHub Markdown, verá un pequeño enlace a la izquierda, también puede usar ese enlace. El formato para ese enlace es <project URL#<header name> . El <header name> debe estar en minúsculas.

Answer 3

Puede elegir el modo de edición "MediaWiki" que generará un toc para los encabezados, por ejemplo

== First ==
== Second ==

Answer 4

Si no está en posición de seguir con Markdown , puede hacer lo siguiente:

• en GitHub / wiki : cambie Markdown a MediaWiki . Use __TOC__ Syntak. Ver sample .
• en GitHub / repo : cambie Markdown a AsciiDoc . Uso :toc: Syntak. Ver demo

Usando los archivos Markdown en un repositorio , puedes obtenerlo en GitHub Pages ya que Jekyll usa Kramdown de manera predeterminada , ya viene con Table Of Content que se genera automáticamente como en Wikipedia :

Use {:toc} Syntak. Ver la explicación

Answer 5

Una solución posible (semiautomatizada) es github-markdown-toc Eugene Kalinin. Esta herramienta esencialmente README.md través de su archivo README.md y rastrea los encabezados de # para crear un TOC.

1. Descargue el script https://github.com/ekalinin/github-markdown-toc

2. Alimente su README.md con el script (como se indica en README.md de Eugene)

   gato README.md | bash github-markdown-toc

3. Corte y pegue TOC generado y colóquelo en la parte superior de su archivo README.md

Tenga en cuenta que esta implementación bash solo funciona en Linux (por lo que puedo decir).

Como nota al margen, hay una implementation golang y probablemente sea más complicado trabajar.

Answer 6

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

• git clone your-repo.wiki.git (agrega el .wiki justo antes de .git para clonar el wiki
• npm i -g markdown-toc
• Inserta <!-- toc --> ( <!-- toc --> mayúsculas y minúsculas) en el descuento de tu wiki
• markdown-toc -i my-wiki-markdown.md ( -i lo editará en su lugar)
• Lucro

Actualización: Creo que quizás https://github.com/thlorenz/doctoc es más popular ahora.