Markdown-innehållsförteckning

Lägg automatiskt till en länkad innehållsförteckning i Markdown-filer

Långa README-filer och interna wikisidor stöter på samma problem: en läsare skrollar igenom hela sidan innan de hittar avsnittet de behöver. Om du någon gång har öppnat en lång Markdown-fil och önskat att den började med en klickbar översikt bygger Markdown-innehållsförteckning en sådan åt dig.

Du ger det en enda Markdown-fil, och det läser varje rubrik, gör varje rubrik till en länk och infogar den listan nära toppen som en ny fil du kan ladda ner. Alternativet som heter Inkludera rubriker upp till nivå låter dig välja 2, 3 eller 4; standardvärdet 3 fångar vanligtvis huvudavsnitt och deras underavsnitt utan att dra in varenda liten rubrik. Länkarna följer standardformatet för Markdown-ankare, så de fungerar likadant i ett kodrepository som på en statisk webbplats.

Bearbetningen sker på webbplatsens egna servrar över en säker anslutning, och filen raderas inom sextio minuter, så ingenting lämnas kvar efteråt. Verktyget bygger bara översikten; det numrerar inte om dina rubriker eller rättar till sådana som hoppar över en nivå, så en ojämn rubrikstruktur ger en ojämn innehållsförteckning. Räta ut rubrikerna först om resultatet ser fel ut, och kör det sedan igen.

Användning är gratis inom en daglig gräns, och ett kostnadsfritt konto tar bort den gränsen. Det fungerar från en webbläsare på en dator eller telefon, utan något att installera.