Markdown Preview
Live Markdown preview
Live Markdown preview Wordt lokaal uitgevoerd in uw browser
About the
De Markdown Preview geeft uw Markdown weer terwijl u typt, naast elkaar, in navolging van CommonMark met de GitHub-extensies die de meeste mensen daadwerkelijk gebruiken: tabellen, takenlijsten, afgeschermde codeblokken, doorhalen en autolinks. Het is de snelste manier om een README te controleren voordat je deze vastlegt, omdat de verschillen tussen hoe Markdown er in de broncode uitziet en hoe het eruit ziet als weergegeven niet duidelijk zijn, en vooral de syntaxis van tabellen faalt stilletjes als een enkele pipe of streepje verkeerd is. De weergegeven HTML kan ook worden gekopieerd als u deze ergens nodig heeft waar Markdown zelf niet wordt verwerkt.
Where people use the
- Het controleren van een README wordt correct weergegeven voordat deze wordt gepusht.
- Het opstellen van release notes of een changelog met live weergave van het resultaat.
- Een Markdown-document converteren naar HTML voor een CMS dat Markdown niet accepteert.
- Het Markdown-pullverzoek van iemand anders beoordelen en zien hoe het eruit zal zien.
How to use the
- 1
Plak of schrijf uw Markdown
De editor accepteert alles, van een enkele alinea tot een volledig document met koppen, lijsten, links en codehekken.
- 2
Bekijk het weergegeven paneel
Het voorbeeld wordt bij elke toetsaanslag bijgewerkt, zodat een kapotte tabel of een niet-gesloten hek onmiddellijk verschijnt in plaats van na een publicatiestap.
- 3
Corrigeer de bron, niet het voorbeeld
Het voorbeeld is alleen-lezen. Wanneer iets verkeerd wordt weergegeven, is de oorzaak bijna altijd een ontbrekende lege regel vóór een lijst of een tabelkop zonder scheidingstekenrij.
- 4
Kopieer de HTML als je deze nodig hebt
Schakel over naar de HTML-weergave om de gegenereerde markup te gebruiken, wat handig is om te plakken in een CMS die HTML verwacht in plaats van Markdown.
Tips en beste praktijken
- Laat voor en na elk blokelement een witregel achter; De meest raadselachtige weergavefouten zijn een ontbrekende lege regel.
- Gebruik afgeschermde codeblokken met een taalnaam, zodat de code wordt gemarkeerd in plaats van als platte tekst te worden behandeld.
- Bewaar één zin per regel in lange documenten; het maakt de diffs later leesbaar.
Veelgestelde vragen
Welke Markdown-specificatie wordt gebruikt?
CommonMark als basis, plus de GitHub Flavoured Markdown-extensies voor tabellen, takenlijsten, afgeschermde code en doorhalen. Die combinatie omvat het README-formaat op GitHub, GitLab en de meeste documentatiesites.
Waarom wordt mijn tabel niet weergegeven?
Een tabel heeft een koprij nodig, onmiddellijk gevolgd door een scheidingstekenrij met streepjes, met een lege regel vóór het blok. Elke rij moet hetzelfde aantal buizen hebben als de header. Elk van deze ontbrekende verandert het hele ding in een alinea tekst met pijptekens erin.
Waarom zijn mijn lijstitems samengevoegd tot één alinea?
Markdown heeft een lege regel nodig tussen een alinea en een lijst die daarop volgt. Zonder dit worden de lijstmarkeringen behandeld als gewone tekst.
Ondersteunt het LaTeX of wiskunde?
Nee. Wiskundige weergave heeft een aparte bibliotheek nodig, zoals KaTeX of MathJax, en een andere syntaxis. Een uitdrukking met een dollarteken wordt hier weergegeven als platte tekst.
Is onbewerkte HTML toegestaan?
Ja, inline HTML gaat er rechtstreeks doorheen, en dat is wat GitHub ook doet. Als u de uitvoer ergens openbaar publiceert, moet u deze eerst opschonen, omdat onbewerkte HTML ook de manier is waarop scripts worden geïnjecteerd.
Waar gaat mijn tekst naartoe?
Nergens. Het parseren en renderen gebeurt in uw browser met een JavaScript Markdown-bibliotheek. Er wordt niets opgeslagen of verzonden, dus het concept is verdwenen wanneer u het tabblad sluit, tenzij u het kopieert.