ToC ou barra lateral no GitHub Wiki

Como faço para criar um ToC ou um menu da barra lateral em um Wiki do GitHub?

Eu vi algumas menções sobre isso e gollum, o back-end parece suportá-lo, mas como faço isso em um projeto GitHub atual?

É melhor que seja baseado nos cabeçalhos que tenho na página automaticamente.

Todos esses links mencionam isso, mas não mostram como fazer:

• https://gist.github.com/379469 - algum hack de JavaScript

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

  "Os wikis do GitHub têm uma capacidade pouco documentada para rodapés e barras laterais, algo com o qual alguns de nossos autores Wiki baseados em git estão familiarizados. O novo editor Wiki oferece edição limitada baseada na web dos rodapés e barras laterais que você tem em seu site. "

Enquanto sua solução funciona, há uma maneira mais fácil de fazer isso usando a interface da web do GitHub. Você pode simplesmente criar uma página chamada _Sidebare / ou _Footer.

Veja instruções detalhadas no construtor de menu da barra lateral do Github Wiki com vários níveis .

Editar O artigo original sumiu e não consigo encontrá-lo no cache, então atualizei o link.

Quando você está no wiki de seu projeto, há um link Adicionar uma barra lateral personalizada . Clique nisso.

Agora você tem uma página que edita como faria com qualquer outra página do Markdown . Para fazer um índice, você deve fazê-lo manualmente. Não há método automatizado (em agosto de 2014). Então, por exemplo:

# 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

OK. Deixe-me ver se entendi corretamente:

1. Clone seu wiki do GitHub. (Há uma seção Git no wiki. Você pode verificar seu código semelhante ao de um wiki.)
2. Crio _Sidebar.md
3. Em páginas wiki normais, use [[link]]para a barra lateral
4. Comprometa-se e volte ao GitHub

Esse processo é um pé no saco. Estou surpreso que este wiki “gollum” tenha alguma aceitação.

Além disso: _Sidebar.md é, portanto, global para todas as páginas . Eu teria que organizar meu wiki em pastas, para poder definir diferentes barras laterais para diferentes páginas.

Observe que a pergunta original era sobre como criar uma barra lateral (fácil, resolvido nas respostas) ou um índice real (não respondido).

Uma coisa que posso dizer é que a sintaxe wiki do gollum 2.1 permite uma [[_TOC_]]tag, mas um wiki do GitHub não reconhecerá isso (ainda?).

Acho que isso está descrito no GollumREADME . (Consulte as seções de cabeçalho e barra lateral.)

Basicamente, você cria um _footer.exte _sidebar.extno diretório que contém o conteúdo da página.

Eu implementei o módulo npm github-wiki-sidebar para ajudar os usuários do github a criar e manter facilmente o menu da barra lateral.

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

Páginas de origem (conforme exibido no admin do Wiki):

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

Resultado (com pedido personalizado):

• Casa
• Instalação
• Uso
  • Modo de inicialização
  • Modificadores de linha de comando
• Roteiro

Pré requisitos:

• clone seu repositório wiki github localmente (exibido no canto inferior direito da IU do Wiki)

• instale o github-wiki-sidebar

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

Crie / atualize seu menu wiki:

• criar novas páginas / renomear páginas em seu administrador de wiki github.com

• execute localmente o script github-wiki-sidebar em sua pasta de repositório 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
  

O módulo permite a personalização da saída do markdown, incluindo a ordem dos itens, o separador de categorias, o modelo para o menu, o formato dos links e outros.

O GitHub irá gerar automaticamente um sumário do documento:

1. Faça com que o documento digite AsciiDoc em vez de Markdown.
2. Insira :toc:no início do documento.