ToC lub pasek boczny w GitHub Wiki

Jak utworzyć ToC lub menu paska bocznego na GitHub Wiki?

Widziałem kilka wzmianek o tym i gollum, że backend wydaje się go obsługiwać, ale jak mam to zrobić w obecnym projekcie GitHub?

Najlepiej powinien być oparty na nagłówkach, które mam na stronie automatycznie.

Wszystkie te linki wspominają o tym, ale nie pokazują, jak to zrobić:

• https://gist.github.com/379469 - jakiś hack JavaScript

• https://github.com/blog/774-git-powered-wikis-improved - wspomina o tym GitHub:

  „Wiki GitHub mają słabo udokumentowane możliwości w zakresie stopek i pasków bocznych, które są znane niektórym z naszych autorów Wiki opartych na git. Nowy edytor Wiki umożliwia ograniczoną internetową edycję stopek i pasków bocznych w witrynie. "

Chociaż Twoje rozwiązanie działa, istnieje łatwiejszy sposób na zrobienie tego za pomocą interfejsu internetowego GitHub. Możesz po prostu utworzyć stronę o nazwie _Sidebari / lub _Footer.

Zobacz szczegółowe instrukcje w wielopoziomowym konstruktorze menu paska bocznego Github Wiki .

Edytuj Oryginalny artykuł zniknął i nie mogę go znaleźć w pamięci podręcznej, więc zaktualizowałem link.

Kiedy jesteś na wiki swojego projektu, znajduje się link Dodaj niestandardowy pasek boczny . Kliknij to.

Teraz masz stronę, którą edytujesz, tak jak każdą inną stronę Markdown . Aby jednak sporządzić spis treści, musisz to zrobić ręcznie. Nie ma metody automatycznej (stan na sierpień 2014). Na przykład:

# 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

W porządku. Zobaczmy, czy dobrze to rozumiem:

1. Sklonuj swoją witrynę wiki GitHub. (Na wiki znajduje się sekcja Git. Możesz sprawdzić swój kod podobny do wiki).
2. Stwórz _Sidebar.md
3. Na normalnych stronach wiki użyj [[link]]jako paska bocznego
4. Zatwierdź i wróć do GitHub

Ten proces to wrzód na dupie. Dziwię się, że ta wiki „gollum” ma jakąkolwiek akceptację.

Ponadto: _Sidebar.md jest zatem globalna dla wszystkich stron . Musiałbym zorganizować moją wiki w foldery, więc mogę zdefiniować różne paski boczne dla różnych stron.

Zwróć uwagę, że pierwotne pytanie dotyczyło utworzenia paska bocznego (łatwe, rozwiązane w odpowiedziach) lub rzeczywistego spisu treści (bez odpowiedzi).

Jedno mogę powiedzieć, że składnia wiki gollum 2.1 pozwala na [[_TOC_]]tag, ale wiki GitHub tego nie rozpozna (jeszcze?).

Myślę, że jest to opisane w GollumREADME . (Zobacz sekcje nagłówka i paska bocznego).

Zasadniczo tworzysz _footer.exti _sidebar.extw katalogu zawierającym zawartość strony.

Zaimplementowałem moduł npm github-wiki-sidebar, aby pomóc użytkownikom github w łatwym tworzeniu i utrzymywaniu menu paska bocznego.

Źródło i wynik: https://raw.githubusercontent.com/wiki/adriantanasa/github-wiki-sidebar/images/github-wiki-sidebar-generator.png

Strony źródłowe (wyświetlane w panelu administracyjnym Wiki):

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

Wynik (z niestandardowym zamówieniem):

• Dom
• Instalacja
• Stosowanie
  • Tryb początkowy
  • Modyfikatory linii poleceń
• Mapa drogowa

Wymagania wstępne:

• klonuj lokalnie repozytorium wiki na githubie (wyświetlane w prawym dolnym rogu interfejsu Wiki)

• zainstaluj pasek boczny github-wiki-side

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

Utwórz / zaktualizuj swoje menu wiki:

• utwórz nowe strony / zmień nazwy stron na swoim administratorze wiki github.com

• wykonaj lokalnie skrypt github-wiki-sidebar w folderze repozytorium 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
  

Moduł umożliwia dostosowanie wyników przeceny, w tym kolejność pozycji, separator kategorii, szablon menu, format linków i inne.

GitHub automatycznie wygeneruje spis treści dokumentu:

1. Ustaw dokument typu AsciiDoc zamiast Markdown.
2. Wstaw :toc:na początku dokumentu.