CDRN

Μετατροπή και προεπισκόπηση Markdown

  • Πίνακας ελέγχου
  • Τεκμηρίωση
  • API
μετατρέπει το Markdown σας σε HTML και εμφανίζει μια ζωντανή προεπισκόπηση, ιδανικό για τη σύνταξη READMEs, τεκμηρίωσης ή άρθρων

Τι είναι το Markdown;

Το Markdown είναι μια ελαφριά γλώσσα σήμανσης που δημιουργήθηκε από τον John Gruber το 2004. Επιτρέπει τη συγγραφή μορφοποιημένου κειμένου χρησιμοποιώντας μια απλή σύνταξη, ευανάγνωστη ακόμη και σε ακατέργαστη μορφή, η οποία στη συνέχεια μετατρέπεται σε HTML.

Αυτό το εργαλείο χρησιμοποιεί την προδιαγραφή GFM (GitHub Flavored Markdown), την πιο διαδεδομένη παραλλαγή, η οποία προσθέτει υποστήριξη για πίνακες, πλαίσια ελέγχου, μπλοκ κώδικα με χρωματισμό σύνταξης και αυτόματους συνδέσμους.

Η προεπισκόπηση στα δεξιά ενημερώνεται σε πραγματικό χρόνο καθώς πληκτρολογείτε. Το κουμπί Υποβολή δημιουργεί τον αντίστοιχο κώδικα HTML, τον οποίο μπορείτε να αντιγράψετε ή να κατεβάσετε.

Βασική σύνταξη Markdown

MarkdownΑπόδοση
# Τίτλος 1Τίτλος <h1>
## Τίτλος 2Τίτλος <h2>
**έντονα**έντονα
*πλάγια*πλάγια
`ενσωματωμένος κώδικας`ενσωματωμένος κώδικας
```php ... ```Μπλοκ κώδικα PHP
[κείμενο](url)Υπερσύνδεσμος
![alt](url)Εικόνα
- στοιχείοΜη ταξινομημένη λίστα
1. στοιχείοΤαξινομημένη λίστα
> παράθεσηBlockquote
---Οριζόντιος διαχωριστής

Συνήθεις περιπτώσεις χρήσης

  • README GitHub: σύνταξη της τεκμηρίωσης ενός έργου ανοιχτού κώδικα.
  • Τεχνική τεκμηρίωση: συγγραφή οδηγών, wiki ή σελίδων τεκμηρίωσης (MkDocs, Docusaurus, Hugo).
  • Άρθρα ιστολογίου: τα περισσότερα CMS (Jekyll, Ghost, Contentful) δέχονται Markdown.
  • Σχόλια και ζητήματα: GitHub, GitLab, Jira, Notion και Slack υποστηρίζουν όλα το GFM.
  • Μορφοποιημένα email: μετατροπή Markdown σε HTML για ενσωμάτωση σε ένα email HTML.
  • Σημειώσεις και παρουσιάσεις: το Obsidian, το Notion, το Marp και το Reveal.js χρησιμοποιούν Markdown.

Συχνές ερωτήσεις

Ποια είναι η διαφορά μεταξύ τυπικού Markdown και GFM;

Το τυπικό Markdown (CommonMark) καλύπτει τα βασικά στοιχεία: τίτλους, λίστες, συνδέσμους, κώδικα. Το GFM (GitHub Flavored Markdown) προσθέτει πίνακες, λίστες εργασιών (- [ ] στοιχείο), κώδικα οριοθετημένο με γλώσσα (```php), αναφορές και αυτόματους συνδέσμους. Αυτό το εργαλείο χρησιμοποιεί GFM μέσω της βιβλιοθήκης league/commonmark.

Είναι ασφαλής ο παραγόμενος κώδικας HTML;

Ναι. Ο μετατροπέας είναι ρυθμισμένος να αφαιρεί τις ακατέργαστες ετικέτες HTML (html_input: strip) και να μπλοκάρει τους μη ασφαλείς συνδέσμους, αποτρέποντας τις επιθέσεις XSS. Ο παραγόμενος κώδικας HTML είναι κατάλληλος για ενσωμάτωση σε μια υπάρχουσα ιστοσελίδα.

Μπορώ να συμπεριλάβω HTML στο Markdown μου;

Για λόγους ασφαλείας, ο ακατέργαστος κώδικας HTML που εισάγεται στο Markdown αφαιρείται κατά τη μετατροπή. Εάν χρειάζεστε προσαρμοσμένη απόδοση HTML, συντάξτε απευθείας τον επιθυμητό κώδικα HTML.

Ποιο είναι το μέγιστο μέγεθος του εγγράφου;

Δεν υπάρχει αυστηρό όριο από την πλευρά του διακομιστή για αυτό το εργαλείο. Για πολύ μεγάλα έγγραφα (περισσότερες από μερικές χιλιάδες γραμμές), η προεπισκόπηση σε πραγματικό χρόνο μπορεί να επιβραδυνθεί ανάλογα με το πρόγραμμα περιήγησής σας.

Παράδειγμα αιτήματος

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

Σχήμα εισόδου

Πεδίο Τύπος Απαιτείται Προεπιλογή
input text –

Σημεία πρόσβασης

  • GET https://cdrn.fr/api/v1/tools - εμφανίζει όλα τα διαθέσιμα εργαλεία
  • GET https://cdrn.fr/api/v1/tools/markdown-formatter - ανακτά το σχήμα αυτού του εργαλείου
  • POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - εκτελεί αυτό το εργαλείο με payload JSON