Konvertera och förhandsvisa Markdown

konverterar din Markdown till HTML och visar en förhandsvisning i realtid, idealiskt för att skriva README-filer, dokumentation eller artiklar

Vad är Markdown?

Markdown är ett lättviktigt märkspråk som skapades av John Gruber 2004. Det gör det möjligt att skriva formaterad text med en enkel syntax som är läsbar i råform, och som sedan konverteras till HTML.

Det här verktyget använder specifikationen GFM (GitHub Flavored Markdown), den mest spridda varianten, som lägger till stöd för tabeller, kryssrutor, kodblock med syntaxmarkering och automatiska länkar.

Förhandsvisningen till höger uppdateras i realtid medan du skriver. Knappen Skicka genererar motsvarande HTML-kod, som du kan kopiera eller ladda ner.

Grundläggande Markdown-syntax

MarkdownResultat
# Rubrik 1Rubrik <h1>
## Rubrik 2Rubrik <h2>
**fet**fet
*kursiv*kursiv
`infogad kod`infogad kod
```php ... ```PHP-kodblock
[text](url)Hyperlänk
![alt](url)Bild
- objektPunktlista
1. objektNumrerad lista
> citatBlockquote
---Vågrät avgränsare

Vanliga användningsfall

  • GitHub README: skriva dokumentation för ett projekt med öppen källkod.
  • Teknisk dokumentation: skriva guider, wikis eller dokumentationssidor (MkDocs, Docusaurus, Hugo).
  • Blogginlägg: de flesta CMS-system (Jekyll, Ghost, Contentful) stöder Markdown.
  • Kommentarer och issues: GitHub, GitLab, Jira, Notion och Slack stöder GFM.
  • Formaterade e-postmeddelanden: konvertera Markdown till HTML för att infoga i ett HTML-e-postmeddelande.
  • Anteckningar och presentationer: Obsidian, Notion, Marp och Reveal.js använder Markdown.

Vanliga frågor

Vad är skillnaden mellan standard-Markdown och GFM?

Standard-Markdown (CommonMark) täcker de grundläggande elementen: rubriker, listor, länkar, kod. GFM (GitHub Flavored Markdown) lägger till tabeller, uppgiftslistor (- [ ] objekt), avgränsad kod med språk (```php), omnämnanden och automatiska länkar. Det här verktyget använder GFM via biblioteket league/commonmark.

Är den genererade HTML-koden säker?

Ja. Konverteraren är konfigurerad att ta bort råa HTML-taggar (html_input: strip) och blockera osäkra länkar, vilket förhindrar XSS-attacker. Den producerade HTML-koden lämpar sig för integrering i en befintlig webbsida.

Kan jag inkludera HTML i min Markdown?

Av säkerhetsskäl tas rå HTML som infogas i Markdown bort vid konverteringen. Om du behöver anpassad HTML-rendering, skriv mål-HTML-koden direkt.

Vad är den maximala dokumentstorleken?

Det finns ingen strikt gräns på serversidan för det här verktyget. För mycket långa dokument (mer än några tusen rader) kan förhandsvisningen i realtid bli långsammare beroende på din webbläsare.

Exempelförfrågan

curl -X POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute \
  -H "Content-Type: application/json" \
  -d '{"input":"..."}'

Indatasschema

Fält Typ Obligatorisk Standard
input text

Slutpunkter

  • GET https://cdrn.fr/api/v1/tools - listar alla tillgängliga verktyg
  • GET https://cdrn.fr/api/v1/tools/markdown-formatter - hämtar schemat för detta verktyg
  • POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - kör detta verktyg med en JSON-payload