CDRN

Muunna ja esikatsele Markdownia

  • Hallintapaneeli
  • Dokumentaatio
  • API
muuntaa Markdownin HTML:ksi ja näyttää reaaliaikaisen esikatselun, ihanteellinen README-tiedostojen, dokumentaation tai artikkelien kirjoittamiseen

Mikä on Markdown?

Markdown on kevyt merkintäkieli, jonka John Gruber loi vuonna 2004. Sen avulla voit kirjoittaa muotoiltua tekstiä yksinkertaisella ja jo raakana luettavalla syntaksilla, joka muunnetaan sitten HTML:ksi.

Tämä työkalu käyttää GFM (GitHub Flavored Markdown) -määritystä, yleisintä muunnelmaa, joka lisää tuen taulukoille, valintaruuduille, syntaksiväritetyille koodilohkoille ja automaattisille linkeille.

Oikealla oleva esikatselu päivittyy reaaliajassa kirjoittaessasi. Lähetä-painike luo vastaavan HTML-koodin, jonka voit kopioida tai ladata.

Markdownin perussyntaksi

MarkdownTulos
# Otsikko 1Otsikko <h1>
## Otsikko 2Otsikko <h2>
**lihavoitu**lihavoitu
*kursivoitu*kursivoitu
`rivinsisäinen koodi`rivinsisäinen koodi
```php ... ```PHP-koodilohko
[teksti](url)Hyperlinkki
![alt](url)Kuva
- kohdeJärjestämätön lista
1. kohdeJärjestetty lista
> lainausBlockquote
---Vaakaerotin

Yleiset käyttötapaukset

  • GitHub README: avoimen lähdekoodin projektin dokumentaation kirjoittaminen.
  • Tekninen dokumentaatio: oppaiden, wikien tai dokumentaatiosivujen kirjoittaminen (MkDocs, Docusaurus, Hugo).
  • Blogiartikkelit: useimmat CMS-järjestelmät (Jekyll, Ghost, Contentful) hyväksyvät Markdownin.
  • Kommentit ja issuet: GitHub, GitLab, Jira, Notion ja Slack tukevat kaikki GFM:ää.
  • Muotoillut sähköpostit: Markdownin muuntaminen HTML:ksi HTML-sähköpostiin upottamista varten.
  • Muistiinpanot ja diaesitykset: Obsidian, Notion, Marp ja Reveal.js käyttävät Markdownia.

Usein kysytyt kysymykset

Mikä on ero standardin Markdownin ja GFM:n välillä?

Standardi Markdown (CommonMark) kattaa peruselementit: otsikot, listat, linkit, koodi. GFM (GitHub Flavored Markdown) lisää taulukot, tehtävälistat (- [ ] kohde), kielellä aidatun koodin (```php), maininnat ja automaattiset linkit. Tämä työkalu käyttää GFM:ää league/commonmark -kirjaston kautta.

Onko luotu HTML turvallista?

Kyllä. Muunnin on määritetty poistamaan raa'at HTML-tagit (html_input: strip) ja estämään turvattomat linkit, mikä ehkäisee XSS-hyökkäykset. Tuotettu HTML soveltuu upotettavaksi olemassa olevalle verkkosivulle.

Voinko sisällyttää HTML:ää Markdowniini?

Turvallisuussyistä Markdowniin lisätty raaka HTML poistetaan muunnoksen yhteydessä. Jos tarvitset mukautettua HTML-renderöintiä, kirjoita kohde-HTML suoraan.

Mikä on dokumentin enimmäiskoko?

Tällä työkalulla ei ole tiukkaa rajaa palvelimen puolella. Hyvin pitkissä dokumenteissa (yli muutama tuhat riviä) reaaliaikainen esikatselu voi hidastua selaimestasi riippuen.

Pyyntöesimerkki

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

Syöteskeema

Kenttä Tyyppi Pakollinen Oletus
input text –

Päätepisteet

  • GET https://cdrn.fr/api/v1/tools - listaa kaikki saatavilla olevat työkalut
  • GET https://cdrn.fr/api/v1/tools/markdown-formatter - hakee tämän työkalun skeeman
  • POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - suorittaa tämän työkalun JSON-payloadilla