it-swarm-es.tech

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

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 de la página.

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

56
Evan

Está bien demostrado en la Tabla de contenido de Markdown Cheatsheet .

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

Si pasas el cursor sobre un encabezado en un archivo de GitHub Markdown, verás un pequeño enlace simple a la izquierda, también puedes usar ese enlace. El formato para ese enlace es <project URL#<header name>. El <header name> debe estar en minúsculas.

66
RyPeck

Una posible solución (semiautomática) es el github-markdown-toc de Eugene Kalinin. Esta herramienta esencialmente cruje a través de su archivo README.md y recorta los encabezados de # para crear un TOC.

  1. Descargue el script https://github.com/ekalinin/github-markdown-toc
  2. Alimente su README.md al guión (como se indica en el README.md de Eugene)

    gato README.md | bash github-markdown-toc

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

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

Como nota al margen, hay un golang implementación y probablemente sea más complicado trabajar.

11
John Tran

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
  • Inserte <!-- toc --> (distingue entre mayúsculas y minúsculas) en la marca de su 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.

9
corysimmons

Actualmente es no es posible hacer eso usando la sintaxis de reducción de marca (.md). Hay una discusión acerca de la generación automática de la tabla de contenido TOC en curso en los archivos de rebajas representados como README.md que enumera algunas de las ideas.

Sin embargo, hay algunas otras soluciones tales como:

8
kenorb

Si no está en la posición de quedarse conMarkdown, puede hacer lo siguiente:

  • en GitHub/wiki: cambia Markdown a MediaWiki . Utilice __TOC__ Sintaxis. Ver muestra .
  • en GitHub/repo: cambia Markdown a AsciiDoc . Utilice :toc: Sintaxis. Ver demo .

Sin embargo, al usar Markdown archivos en GitHub/repo, puede obtenerlo en GitHub Pages like en Wikipedia

  • cuando Jekyll está activado, genera GitHub Pages usando Kramdown por defecto
  • Kramdown viene con Table Of Content. Utilice {:toc} Sintaxis. Ver la explicación .
4
Chetabahana

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

== First ==

== Second ==
2
Stefan

Ya que github no puede usar TOC directamente, pero tenemos otras alternativas.

Puede generar automáticamente TOC a través de Herramienta en línea:

Generar tabla de contenidos TOC desde GitHub Markdown o Wiki Online

 enter image description here 

o vía Herramienta local:

github-markdown-toc

1
Bravo Yeung

La solución más simple para mí (aunque siempre tengo instalado el servidor node.js y como npm tiene npx) es ejecutando npx markdown-toc . Parece que es una de las soluciones más populares para esta tarea:

ls
cat <<EOF >> test.md | tee 
## Table of Contents

<!-- toc -->
- old toc 1
- old toc 2
- old toc 3
<!-- tocstop -->

## abc
This is a b c.

## xyz
This is x y z.
EOF
ls
cat test.md
npx markdown-toc -i test.md
cat test.md

salida:

 enter image description here 

0
stopsopa