Tabela zawartości Markdown

Spis treści to lista nagłówków dla rozdziałów lub sekcji dokumentu, ułożonych zgodnie z ich sekwencją wyglądu. W Markdown możesz albo utworzyć spis treści ręcznie lub wygenerować ją automatycznie. W przypadku tej lekcji będziemy ćwiczyć ręczne konstruowanie Markdown TOC.

Tworzenie spisu treści w Markdown:

Tabela treści można utworzyć w dokumencie za pomocą natywnej składni Markdown. Ten samouczek pomoże nam nauczyć się generowania tabeli Markdown treści.

Do praktycznego wdrożenia skryptów Markdown potrzebujemy narzędzia obsługującego język Markdown. Wybraliśmy kod Visual Studio dla kompilacji przykładowych kodów. Po uruchomieniu narzędzia utworzyliśmy nowy plik i ustawiliśmy jego typ na „Markdown.„Aby otworzyć okno podglądu, po prostu naciśnij klawisze„ Ctrl+Shift+V ”. Teraz mamy plik „Markdown” i odpowiadające okno podglądu.

Narzędzie do kompilacji skryptu jest teraz ustawione. Tworzenie tabeli treści rozpocznie się później. W pliku Markdown najpierw utworzyliśmy nagłówek. Aby stworzyć nagłówek, musimy dodać symbol skrótu (#). Dodanie pojedynczego skrótu (#) odnosi się do pierwszego nagłówka. Po symbolu HASH należy podać przestrzeń przed napisaniem tekstu nagłówka. Tekst, który określliśmy dla nagłówka naszego dokumentu, brzmi: „Spis treści.„To stworzy nagłówek z rozmiarem H1 na górze naszej strony internetowej.

Następnie pominęliśmy kilka wierszy przed napisaniem następnego skryptu. Teraz utworzymy listę nagłówków treści dostępnych w dokumencie. Aby utworzyć listę Markdown, mamy dwie opcje: czy utworzyć uporządkowane listy, czy listy nieopisane. W celu generowania listy musimy napisać wartość liczbową i dodać kropkę (.) natychmiast po nim. Następnie, po przestrzeni, wspomnij o pozycjach listy. W przypadku elementów listy tutaj musimy utworzyć linki Markdown, które skierują nas do konkretnej sekcji dokumentu po kliknięciu.

Więc dodaliśmy pierwszą listę listy z wartością numeryczną „1”, a następnie utworzyć link do sekcji strony, najpierw napisaliśmy tytuł nagłówka w nawiasach kwadratowych, a następnie okrągłe aparaty ortodontyczne, które pomieści skrót (#) symbol i tytuł nagłówka, do którego może kierować użytkownika. Nie możesz podać żadnej zakładki ani miejsca w okrągłych klamrach podczas dodawania linków do części dokumentu. Zamiast tego możesz użyć dystansów (-), gdzie potrzebne jest jako zamiennik przestrzeni. Tak więc dla pierwszej listy dodaliśmy link jako „1. [Wprowadzenie] (#Wprowadzenie)."

Tekst w nawiasie kwadratowym zostanie wyświetlony tak, jak jest, a po kliknięciu go przewija do części dokumentu, w której znajdzie ten sam tekst nagłówka, który dostarczyliśmy w okrągłych klamrach. Druga lista jest dołączona jako „2. [Temat 1] (#Topic-1).”Tutaj„ Temat 1 ”zostanie renderowany, a„#Temat-1 ”zostanie osadzone jako link do sekcji. Trzecia lista ma tekst „3. [Temat 2] (#Topic-2).”A ostatni element ma to jako„ 4. [Temat 3] (#Temat-3)."

Teraz tworzymy podtytuły o tym samym tytule, co wspomniane w linku do sekcji listy. Aby utworzyć podtytuły, musimy użyć podwójnych skrótów (##). Po symbolach umieść przestrzeń, a następnie zapisz tytuł nagłówka, który powinien być taki sam, jak zdefiniowano dla linku na powyższej liście. Jeśli dodamy inny tytuł, link nie zadziała. Więc dodaliśmy pierwsze podtytuł po włożeniu skrótów jako „Wprowadzenie.„Po drugie, trzecie i czwarte nagłówki tytuły to odpowiednio„ Temat 1 ”,„ Temat 2 ”i„ Temat 3 ”.

Okno podglądu pokazuje nam odpowiedni przewidywany wynik tego skryptu Markdown, w którym spis treści jest generowany z 4 elementami listy, a ich pozycje odniesienia zostały wyświetlone poniżej.

Wszystkie to treści tekstowe. Możemy również dodać link zewnętrzny jako nagłówek w tabeli treści. Będziemy postępować zgodnie z tym samym wzorem, którego użyliśmy w poprzednim listy, tworzenie elementu, z wyjątkiem jednej rzeczy. Dodamy link do strony internetowej z linkiem sekcji również w okrągłym nawiasach. W tym celu najpierw utworzyliśmy kolejny element listy jako „5. [Temat 4] (#Temat-5httpwwwyyahoocom).„Możesz zobaczyć, że nie dodaliśmy żadnych kropek w nazwie strony internetowej.

Teraz musimy utworzyć nagłówek odpowiadający temu linkowi. Dodaliśmy więc podwójne skróty i przestrzeń, a następnie nie napiszemy tekstu dla tytułu; Zamiast tego utworzymy link. Najpierw napisalibyśmy tekst linku, który wstawiliśmy taki sam, jak dla nowej listy „[Temat 5].”Następnie wstawiliśmy okrągłe nawiasy natychmiast po kwadratowych nawiasach i napisaliśmy kompletny link do strony jako„ http: // www.wieśniak.com ”.

To doda kolejne nagłówek do spisu treści, ale jest to link, a nie zwykły tekst.

Widać, że ostatnie nagłówek zostało podkreślone, co oznacza, że ​​jest to link. Po kliknięciu go otworzy określony adres internetowy w przeglądarce. Tutaj dostarczyliśmy „yahoo.com ”. Więc otworzy Yahoo w naszej przeglądarce.

Z powodzeniem wygenerowaliśmy spis treści w Markdown, który ma w sobie pewne nagłówki i listę. Teraz zobaczymy, w jaki sposób możemy dodać podtytuły do ​​głównych nagłówków listy.

Z listy treści, którą wygenerowaliśmy wcześniej, wybraliśmy 2^Nd Lista pozycja, która ma tytuł „Temat 1”. Aby utworzyć listę dzieci, musimy wprowadzić dwie przestrzenie w wierszu obok elementu listy nadrzędnej. Po podaniu przestrzeni ponumerowaliśmy listę „1.”Następnie użyliśmy kwadratowych nawiasów do określania tytułów, a następnie natychmiast okrągłe wsporniki, aby podać link do określonej części dokumentu. Więc dodaliśmy dwa elementy listy dzieci jako „1. [Sub-topic 1] (#sub-topic-1) ”, a w następnym wierszu drugi element to„ 2. [Sub-topic 2] (#sub-topic-2.) ”

Następnie, przechodząc do części treści dokumentu, dodaliśmy dwa nowe podmioty. Aby tworzyć podwyrężenia z poziomem 3, musimy dodać 3 symbole skrótu (#), a następnie przestrzeń i tekst podtrzymania. Określiliśmy te same tytuły, o których wspomnieliśmy do łączenia sekcji na liście. Pierwszy podtytuł ma tytuł „suban 1”, a drugi to „suban 2."

W migawce okna podglądu poniżej widać, że podtytuły zostały pomyślnie dołączone do naszej spisu treści.

Wniosek

Spis treści (TOC) można wygenerować ręcznie w dokumencie Markdown. W tym przewodniku pracowaliśmy nad zdolnością Markdown polegającej na ręcznym generowaniu spisu treści. Wykonaliśmy fragmenty kodu i opracowaliśmy całą użytą składnię i kroki, które należy wykonać. Nauczyliśmy się tworzyć prosty spis treści z listą Markdown i nagłówkami. Ponadto osadzenie zewnętrznych linków w nagłówkach dokumentu sprawia, że ​​jest dla Ciebie kompleksowy.