Back

Anteprima Markdown

Markdown e un linguaggio di markup leggero per creare testo formattato usando la sintassi in testo semplice. Popolare per la documentazione, i file README e la presa di appunti, viene renderizzato in HTML per la visualizzazione. Questo strumento fornisce un'anteprima Markdown con rendering dal vivo, estrae la struttura del documento (intestazioni, link, immagini) e puo convertire in HTML.

Specifiche

Casi d'uso comuni

  • Anteprima dei file README.md prima del commit
  • Revisione della formattazione della documentazione
  • Estrazione di tutti i link da un documento per la validazione
  • Conversione di Markdown in HTML per l'incorporamento
  • Analisi della struttura e della navigazione del documento

Funzionalità

  • Anteprima dal vivo con rendering HTML
  • Estrazione della struttura del documento (intestazioni come indice)
  • Elenco di tutti i link e le immagini nel documento
  • Rilevamento e visualizzazione dei blocchi di codice con indicazione del linguaggio
  • Analisi del frontmatter (metadati YAML)
  • Conversione in output HTML pulito
  • Statistiche di conteggio parole e caratteri

Esempi

README con funzionalita

Provalo →

Un tipico README di progetto con intestazioni, liste e codice.

# My Project

A brief description of what this project does.

## Installation

```bash
npm install my-project
```

## Features

- **Fast** - Optimized for speed
- **Simple** - Easy to use API
- **Flexible** - Works with any framework

## Links

- [Documentation](https://docs.example.com)
- [GitHub](https://github.com/example/project)

Suggerimenti

  • Usa # per le intestazioni (# H1, ## H2, ### H3, ecc.).
  • I blocchi di codice usano tripli backtick con un identificatore di linguaggio opzionale.
  • I link usano la sintassi [testo](url); le immagini usano ![alt](url).
  • Il frontmatter tra righe --- puo contenere metadati YAML.

Approfondimenti Anteprima Markdown

Markdown e un linguaggio di markup leggero creato da John Gruber nel 2004, progettato per essere leggibile come testo semplice mentre si converte in modo pulito in HTML. La sua sintassi usa caratteri di punteggiatura che suggeriscono visivamente la loro formattazione: # per le intestazioni, * per l'enfasi, - per le liste e backtick per il codice. I file Markdown rimangono utili anche senza rendering, motivo per cui il formato domina per la documentazione, i file README e la scrittura tecnica.

La specifica CommonMark (2014) ha affrontato le molte ambiguita del Markdown originale. CommonMark definisce con precisione come vengono gestiti i casi limite, e la maggior parte dei parser moderni la implementa. GitHub Flavored Markdown (GFM) estende CommonMark con tabelle, liste di attivita, testo barrato, URL auto-collegati e blocchi di codice con evidenziazione della sintassi.

GFM e lo standard de facto per i file README, le descrizioni delle pull request, i commenti alle issue e i siti di documentazione. La maggior parte delle piattaforme di documentazione (Notion, Docusaurus, MkDocs, GitBook) supporta GFM o un suo superset.

Il frontmatter e una convenzione comune per aggiungere metadati strutturati ai file Markdown. Un blocco YAML delimitato da righe --- all'inizio del file puo contenere titolo, data, autore e tag usati dai generatori di siti statici (Astro, Hugo, Jekyll, Next.js) per costruire la navigazione e i layout delle pagine.

Nella pratica, "Markdown" si riferisce quasi sempre a CommonMark o GFM. La specifica Markdown originale lasciava molti casi limite indefiniti, e CommonMark ha risolto quelle ambiguita con una specifica rigorosa. GFM estende CommonMark con tabelle, liste di attivita, testo barrato e URL auto-collegati. Quando si valuta un parser o renderer Markdown, verificare la sua conformita CommonMark e un indicatore affidabile di quanto bene gestisca i casi limite.

Le tabelle in GFM usano pipe (|) per separare le colonne e trattini (-) per la riga divisoria dell'intestazione. L'allineamento delle colonne e controllato con i due punti nel divisore: :--- per allineamento a sinistra, :---: per centrato, e ---: per allineamento a destra. Le tabelle sono un'estensione GFM e non fanno parte della sintassi Markdown originale. Il frontmatter, delimitato da righe --- all'inizio del file, e un blocco di metadati YAML usato dai generatori di siti statici per i metadati della pagina come titolo, data, layout e tag. GitHub renderizza il frontmatter come tabella in cima al file, anche se non tutti i renderer lo elaborano.

I blocchi di codice delimitati usano tripli backtick con un identificatore di linguaggio opzionale dopo i backtick di apertura, ad esempio una riga con tre backtick seguita da "javascript" avvia un blocco JavaScript con evidenziazione della sintassi. Gli identificatori di linguaggio disponibili dipendono dalla piattaforma di rendering. L'indentazione del codice di quattro spazi crea anche un blocco di codice, ma senza la possibilita di specificare un linguaggio per l'evidenziazione.

← Torna a tutti gli strumenti