sesion - github tutorial

ToC o barra lateral en GitHub Wiki

Question

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

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

Debería basarse 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 hack JavaScript

• https://github.com/blog/774-git-powered-wikis-improved - GitHub mencionándolo:

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

Answer 1

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

Answer 2

Bueno. Déjame ver si entiendo esto correctamente:

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

Este proceso es un dolor en el culo. Me sorprende que esta wiki "gollum" tenga alguna aceptación.

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

Answer 3

Creo que esto se describe en github.com/github/gollum . (Consulte las secciones de encabezado y barra lateral).

Básicamente, _footer.ext un _footer.ext y _sidebar.ext en el directorio que contiene el contenido de la página.

Answer 4

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 edita, ya que editaría cualquier otra página de Markdown . Para hacer una tabla de contenidos, debes hacerlo manualmente. No hay un método automatizado (desde 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

Answer 5

He implementado el módulo 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):

• Home
• Installation
• Usage
  • Modo Init
  • Modificadores de línea de comando
• Roadmap

Pre requisitos:

• clona tu repositorio wiki de github localmente (se muestra en la esquina inferior derecha de la IU de 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

Crea / actualiza tu menú wiki:

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

• ejecuta localmente la secuencia de comandos 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 del resultado de rebajas, incluido el orden de los artículos, el separador de categorías, la plantilla para el menú, el formato de los enlaces y otros.

Answer 6

Tenga en cuenta que la pregunta original era sobre la creación de una barra lateral (fácil, resuelta en las respuestas) o una tabla de contenidos real (no respondida).

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

Answer 7

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

Vea las instrucciones detalladas en AGREGAR UNA TABLA DE CONTENIDO A SU GITHUB WIKI .