Markdown inhoudsopgave

Automatisch een gekoppelde inhoudsopgave toevoegen aan Markdown-bestanden

Lange README-bestanden en interne wiki's lopen tegen hetzelfde probleem aan: een lezer scrollt door de hele pagina voordat hij de gezochte sectie vindt. Als u ooit een lang Markdown-bestand hebt geopend en wenste dat het begon met een klikbaar overzicht, dan bouwt Markdown inhoudsopgave er een voor u.

U geeft de tool een enkel Markdown-bestand, en deze leest elke kop, zet elke kop om in een link en voegt die lijst boven aan een nieuw bestand in dat u kunt downloaden. Met de optie Kopniveaus tot en met opnemen kunt u kiezen uit 2, 3 of 4; de standaardwaarde van 3 vangt meestal de hoofdsecties en hun subsecties op zonder elke kleine kop mee te nemen. De links volgen de standaard Markdown-ankerstijl, zodat ze op dezelfde manier werken in een coderepository of een statische site.

De verwerking gebeurt op de eigen servers van de site via een beveiligde verbinding, en het bestand wordt binnen zestig minuten verwijderd, zodat er achteraf niets blijft staan. De tool bouwt alleen het overzicht; deze hernummert uw koppen niet en corrigeert geen koppen die een niveau overslaan, dus een ongelijke kopstructuur levert een ongelijke inhoudsopgave op. Zet de koppen eerst recht als het resultaat er verkeerd uitziet en voer de tool daarna opnieuw uit.

Gebruik is gratis binnen een dagelijkse limiet, en een gratis account verwijdert die limiet. De tool werkt vanuit een browser op een computer of telefoon, zonder iets te installeren.