TdC o Barra lateral en GitHub Wiki

Mientras tu solución funciona, hay una manera más fácil de hacerlo usando la interfaz web de GitHub. Simplemente puede crear una página llamada _Sidebar y/o _Footer.

Ver instrucciones detalladas en Github Wiki sidebar menu builder con multi-nivel.

Edit El artículo original se ha ido y no puedo encontrarlo en la caché, así que he actualizado el enlace.

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

Ahora tienes una página que editas como editarías cualquier otra página Markdown. Para hacer una tabla de contenido tienes que hacerlo manualmente. No hay ningún método automatizado (a partir de agosto de 2014). 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

Tenga en cuenta que la pregunta original era sobre 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 etiqueta [[_TOC_]], pero un wiki de GitHub no lo reconocerá (¿todavía?).

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

Esencialmente, se hacen _footer.ext y _sidebar.ext en el directorio que contiene el contenido de la página.

Acabo de crear un script Python que genera un índice en el _Sidebar.md de GitHub basado en la estructura de carpetas y páginas en el wiki git.

He implementado 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 fuente (como se muestra en Wiki admin):

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

Resultado (con personalizado orden):

• Inicio
• Instalación
• Uso
  • Modo Init
  • Modificadores de línea de comandos
• Hoja de ruta

Requisitos previos:

• clona tu repositorio wiki de github localmente (mostrado en la parte inferior derecha de la interfaz de usuario del Wiki)

• Instala la barra lateral de github-wiki

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

Crear/actualizar su menú wiki:

• crear nuevas páginas / renombrar páginas en su github.com administrador de wiki

• Ejecuta localmente el script github-wiki-sidebar en tu 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 markdown incluyendo el orden de los elementos, el separador de categorías, la plantilla para el menú, el formato de los enlaces y otros.