ToC lub pasek boczny w GitHub Wiki

88

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ć:

github  wiki 
— wolle
źródło
3
Stworzyłem GitHub Wikifier: Wstępnie zatwierdzony hak Git, który wygeneruje cały spis treści, jakiego kiedykolwiek będziesz potrzebować. Po prostu napisz treść i pozwól jej przejąć. Może warto sprawdzić. github.com/kuroir/GitHub-Wikifier
— MarioRicalde,
— Ciro Santilli 郝海东 冠状 病 六四 事件 法轮功
— Jonny

Odpowiedzi:

76

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.

— nicerobot
źródło
7
@CodeSherpa są dostępne pod adresem https://github.com/[user]/[repo]/wiki/_Sidebar/_editihttps://github.com/[user]/[repo]/wiki/_Footer/_edit
— nicerobot
1
Artykuł był świetny, ale zawiera nieprawidłowe (lub nieaktualne) informacje o tym, jak uzyskać adres URL wiki. Jeśli jesteś tak zagubiony jak ja, musisz użyć adresu URL https://github.com/<username>/<projectname>.wiki.gitlub SSH git@github.com:<username>/<projectname>.wiki.git.
— NightOwl888,
1
Te szczegółowe instrukcje są dość kiepskie. Co to jest [[link]]? Umieszczenie adresu URL w tym miejscu powoduje wyświetlenie całego adresu URL.
— Pithikos,
3
@Pithikos mówi Github Markdown. Nie ma instrukcji, które mogłyby cię nauczyć Markdown. Są tam, aby wyjaśnić paski boczne.
— nicerobot
2
@nicerobot, a najlepszym sposobem wyjaśnienia czegoś jest użycie konkretnego przykładu ..
— Pithikos
26

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

Tutaj wprowadź opis obrazu

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
— Pithikos
źródło
25

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.

— wolle
źródło
2
Zgodnie z dokumentacją możesz dodać różne paski boczne dla różnych folderów: „Paski boczne wpływają na wszystkie strony w ich katalogu i wszystkie podkatalogi, które nie mają własnego pliku paska bocznego”. patrz: github.com/github/gollum
— Subfuzion
10

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?).

— znak
źródło
4
Miałeś szczęście? To strasznie frustrujące, ponieważ pochodzi z Trac, gdzie wszystkie te rzeczy można było łatwo zrobić.
— wystukuje
Myślę, że lepszą odpowiedzią na pierwotne pytanie, jak zrobić spis treści „na podstawie nagłówków, które mam na stronie automatycznie” jest to, że jest to obecnie niemożliwe z GitHub Wiki.
— avernet
Jest to obecnie otwarta kwestia (zbyt leniwa, by sprawdzić liczbę), którą skomentowały setki ludzi. Nie ma jeszcze żadnej wiadomości od GitHub :(
— abalter
— ckib16
4

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.

— seandavi
źródło
2

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):

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.

— adtanasa
źródło
0

GitHub automatycznie wygeneruje spis treści dokumentu:

  1. Ustaw dokument typu AsciiDoc zamiast Markdown.
  2. Wstaw :toc:na początku dokumentu.
— Dogweather
źródło
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.