Table of Contents
Ein Inhaltsverzeichnis, erstellt aus den Überschriften jedes Beitrags, mit Sprunglinks. Beim Schreiben ist nichts einzufügen.
Erweiterung
Table of Contents
Ein Inhaltsverzeichnis, erstellt aus den Überschriften jedes Beitrags, mit Sprunglinks. Beim Schreiben ist nichts einzufügen.
Installation
Zwei Schritte
- Öffnen Sie in Ihrer EmDash-Administration Registry, suchen Sie nach Table of Contents und klicken Sie auf Install. Es fragt nach keinen Berechtigungen.
- Öffnen Sie Table of Contents im linken Menü, wechseln Sie zum Tab Setup und fügen Sie den dort angezeigten kurzen Block in den Head Ihres Basis-Layouts ein, in der Regel
src/layouts/Base.astro. Wenn jemand anderes Ihre Website gebaut hat, schicken Sie ihm diesen Block.
Das ist alles. Jeder Beitrag und jede Seite mit genügend Überschriften erhält ein Inhaltsverzeichnis, und Autoren müssen nichts tun. Im Tab Settings legen Sie den Titel fest, welche Überschriften zählen, wo die Liste steht und ob sie eingeklappt startet.
Um die genaue Stelle selbst zu wählen, setzen Sie “ in Ihre Beitragsvorlage. Um eine Überschrift auszulassen, geben Sie ihr data-toc-skip.
FAQ
Was macht dieses Plugin?
Es liest die Überschriften eines Beitrags oder einer Seite im Browser des Lesers und zeigt oben eine Liste von Sprunglinks. Ein Klick auf eine Zeile scrollt zu diesem Abschnitt, der aktuelle Abschnitt wird beim Lesen markiert, und die Adressleiste erhält den Abschnittslink, sodass er geteilt werden kann. Autoren fügen nichts ein.
Welche Überschriften werden verwendet?
Ihre Wahl: nur H2, H2 und H3 oder H2 bis H4. H3-Zeilen stehen unter ihrer H2. H1 wird nie verwendet, denn das ist der Beitragstitel.
Meine Überschriften haben keine ids. Funktioniert es trotzdem?
Ja. Das Plugin gibt jeder Überschrift, die keine hat, eine aus ihrem Text gebildete id, sodass die Links in jedem Theme funktionieren.
Kann ich es bei einem kurzen Beitrag abschalten?
Die Liste erscheint nur, wenn eine Seite mindestens so viele Überschriften hat, wie Sie festgelegt haben, standardmäßig drei. Für einen ganzen Bereich der Website verwenden Sie Show on mit einem Adressanfang wie /posts.
Wo steht es?
Vor der ersten Überschrift, nach dem ersten Absatz oder am Anfang des Inhaltsbereichs. Wenn Sie es woanders haben möchten, setzen Sie ein leeres Element mit data-toc in Ihre Vorlage, und es erscheint dort.
Eine Überschrift verschwindet nach einem Sprung unter meinem fixierten Menü
Setzen Sie Sticky header height in Settings auf die Höhe Ihrer Menüleiste in Pixeln.
Sammelt es irgendetwas?
Nein. Das Plugin hat keinen Zugriff auf Ihre Inhalte und stellt keine Anfragen außerhalb Ihrer Website. Der einzige Aufruf ist, dass Ihre Website ihre eigenen Einstellungen abruft.
Verlangsamt es die Website?
Das Skript ist etwa 5 KB groß, wird geladen, sobald die Seite bereit ist, und eine Minute lang zwischengespeichert. Von anderen Servern wird nichts geladen.
Änderungsprotokoll
0.1.0
- Erste Version. Ein Inhaltsverzeichnis, erstellt aus den Überschriften jedes Beitrags oder jeder Seite, mit Sprunglinks, sanftem Scrollen und Markierung des aktuellen Abschnitts.
- Einstellungen: Titel, welche Überschriftenebenen zählen, Mindestanzahl an Überschriften, Position, Nummerierung, eingeklappt starten, überall oder auf Adressen anzeigen, die mit einem Pfad beginnen, Höhe des fixierten Headers, Inhaltsbereich.
- Selbst platzieren mit
data-toc. Eine Überschrift auslassen mitdata-toc-skip. - Der Tab Setup zeigt, ob die Website das Inhaltsverzeichnis lädt.