För vem
Flytta dokumentation till Markdown utan städning
Att migrera dokumentation brukar innebära att man omvandlar HTML och sedan lägger längre tid på att ta bort det omvandlaren behöll. Borttagningen är det Clean Clipper är byggt kring, och den är också den del som är mätt: noll kvarlämnade HTML-taggar över 512 sidor, och språkmärkningar som sitter kvar på kodblocken.
Varför en migrering drar ut
Omvandlingen i sig är inte problemet: rubriker blir rubriker och listor blir listor. Problemet är vad som följer med. Navigeringsträdet i sidomenyn, versionsväljaren, raden med ”lämna synpunkter” och innehållsförteckningen till höger ligger i samma behållare som texten och hamnar därför i varje fil. Vid trettio sidor är det trettio gånger samma handarbete.
Samtidigt tappar innehållet just det som gör det tekniskt. Kodblock kommer in nakna, parametertabeller bryts på cellen som rymmer ett exempel, och lösa div- och span-rester blir kvar mitt i texten. Den som städar det i efterhand med sök och ersätt river förr eller senare bort något som faktiskt var innehåll.
Vad som kommer över
- Rubriker, listor, tabeller, kodblock och fotnoter blir alla vanlig Markdown
- Språkmärkningen sitter kvar på kodblocken – 73 av 156 på det tekniska korpuset, mot 20 och 0
- Noll kvarlämnade HTML-taggar över 512 mätta sidor
- Navigeringsmenyer, versionsväljare och ”på den här sidan”-block klipps bort, de omvandlas inte
- Tomma rubriker, en vanlig rest av navigeringsblock, faller bort
- Filnamnsmall och undermapp håller ordning på en importerad uppsättning
## 3.2 Sidindelning En samling returneras sidindelad. Klienten följer länken med relationen `next` tills den saknas. | Parameter | Typ | Obligatorisk | | --- | --- | --- | | `limit` | heltal | nej | | `cursor` | sträng | nej | ### 3.2.1 Felsituationer
Vad det inte gör
Det finns ingen crawler och ingen satsvis bearbetning: du sparar de sidor du själv besöker, en i taget. Notisrutor och callouts blir blockcitat, eftersom Markdown saknar standardsyntax för dem. Flikar, dragspel och andra delar som visar innehåll först efter ett klick följer bara med om de står öppna just då. Och bilder och diagram förblir länkar till originalsidan.