ToC o barra lateral en GitHub Wiki

¿Cómo creo un ToC o un menú de barra lateral en un Wiki de GitHub?

Vi algunas menciones y gollum el backend parece admitirlo, pero ¿cómo lo hago en un proyecto actual de GitHub?

Debería basarse mejor en los encabezados que tengo en la página automáticamente.

Todos estos enlaces lo mencionan, pero no muestran cómo hacerlo:

• https://gist.github.com/379469 - algunos trucos de JavaScript

• https://github.com/blog/774-git-powered-wikis-improved - GitHub lo menciona:

  "Los Wikis de GitHub tienen una capacidad poco documentada para pies de página y barras laterales, algo con lo que algunos de nuestros autores de Wiki basados ​​en git están familiarizados. El nuevo editor Wiki le brinda una edición limitada basada en la web de los pies de página y barras laterales que tiene en su sitio. "

Mientras su solución funciona, hay una manera más fácil de hacerlo usando la interfaz web de GitHub. Simplemente puede crear una página con el nombre _Sidebary / o _Footer.

Consulte las instrucciones detalladas en el generador de menús de la barra lateral de Github Wiki con varios niveles .

Editar El artículo original desapareció y no puedo encontrarlo en la caché, así que actualicé el enlace.

Cuando estás en la wiki de tu proyecto, hay un enlace Agregar una barra lateral personalizada . Haga clic en eso.

Ahora tiene una página que puede editar como editaría cualquier otra página de Markdown . Sin embargo, para hacer una tabla de contenido, debe hacerlo manualmente. No existe un método automatizado (a partir de agosto de 2014). Así por ejemplo:

# My menu
* [Home][home]
* [Technical documentation][techdocs]
* [User manual][usermanual]

[home]: https://github.com/myproject/wiki/Home
[techdocs]: https://github.com/myproject/wiki/Technical-documentation
[usermanual]: https://github.com/myproject/wiki/User-manual

Bueno. Déjame ver si entiendo esto correctamente:

1. Clona tu wiki de GitHub. (Hay una sección de Git en la wiki. Puede consultar su código similar a una wiki).
2. Crear _Sidebar.md
3. En páginas wiki normales, use [[link]]para la barra lateral
4. Confirmar y devolver a GitHub

Este proceso es un dolor de cabeza. Me sorprende que esta wiki de "gollum" tenga alguna aceptación.

Además: _Sidebar.md es por tanto global para todas las páginas . Tendría que organizar mi wiki en carpetas, para poder definir diferentes barras laterales para diferentes páginas.

Tenga en cuenta que la pregunta original se refería a la creación de una barra lateral (fácil, resuelto en las respuestas) o una tabla de contenido real (no respondida).

Una cosa que puedo decir es que la sintaxis wiki de gollum 2.1 permite una [[_TOC_]]etiqueta, pero una wiki de GitHub no reconocerá eso (¿todavía?).

Creo que esto se describe en el GollumREADME . (Consulte las secciones de encabezado y barra lateral).

Básicamente, crea un _footer.exty _sidebar.exten el directorio que contiene el contenido de la página.

Implementé el módulo npm github-wiki-sidebar para ayudar a los usuarios de github a crear y mantener fácilmente el menú de la barra lateral.

Fuente y resultado: https://raw.githubusercontent.com/wiki/adriantanasa/github-wiki-sidebar/images/github-wiki-sidebar-generator.png

Páginas de origen (como se muestra en el administrador de Wiki):

Home
Installation
Roadmap
Usage
Usage: Command line modifiers
Usage: Init Mode

Resultado (con pedido personalizado):

• Hogar
• Instalación
• Uso
  • Modo de inicio
  • Modificadores de línea de comando
• Mapa vial

Pre requisitos:

• clone su repositorio wiki de github localmente (que se muestra en la parte inferior derecha de la interfaz de usuario de Wiki)

• instalar la barra lateral de github-wiki

  git clone <https://github.com/<username>/<my-project-name>.wiki.git
  npm install -g github-wiki-sidebar
  

Crea / actualiza tu menú wiki:

• crear nuevas páginas / cambiar el nombre de las páginas en su administrador wiki de github.com

• ejecute localmente el script github-wiki-sidebar en su carpeta de repositorio wiki

  cd /path/to/<my-project-name>.wiki
  # this fetches latest changes, generates sidebar file (_Sidebar.md) and pushes changes to github
  github-wiki-sidebar --git-push
  

El módulo permite la personalización de la salida de rebajas, incluido el orden de los elementos, el separador de categorías, la plantilla para el menú, el formato de los enlaces y otros.

GitHub generará automáticamente una tabla de contenido del documento:

1. Haga que el documento escriba AsciiDoc en lugar de Markdown.
2. Insertar :toc:al principio del documento.