Scrivi un README con elenchi puntati annidati, un paio di blocchi di codice e una tabella che confronta due approcci. Sembra a posto come testo semplice nel tuo editor. Poi lo pubblichi su GitHub e la tabella è disallineata, uno dei tuoi blocchi di codice non si è chiuso correttamente, e un elenco numerato è ripartito da 1 a metà a causa di una riga vuota di troppo. Ora stai facendo piccoli commit correttivi solo per sistemare la formattazione.
Markdown è abbastanza semplice da scrivere a memoria per la formattazione di base, ma tabelle, elenchi annidati e blocchi di codice hanno tutti piccole stranezze sintattiche che differiscono leggermente tra i vari motori di rendering. Il GitHub Flavored Markdown non è identico a CommonMark, che non è identico a qualsiasi cosa usi il tuo generatore di siti statici. Il divario tra "sembra giusto nella mia testa" e "viene renderizzato correttamente sulla pagina" è esattamente dove un'anteprima in tempo reale si guadagna il suo posto.
Perché Fare Commit per Controllare è un Cattivo Flusso di Lavoro
Fare push di un commit solo per vedere come viene renderizzato un README, poi farne un altro per correggere una tabella rotta, poi un altro ancora per correggere la correzione, intasa la cronologia dei commit con rumore di formattazione che non ha nulla a che fare con il contenuto vero e proprio. Significa anche che ogni ciclo di anteprima richiede tanto tempo quanto un push e un ricaricamento della pagina — abbastanza lento da smettere di controllare e sperare semplicemente che vada bene.
Vedi l'Output Renderizzato Mentre Digiti
Bellows include uno strumento di anteprima Markdown che renderizza l'output formattato mentre incolli o digiti Markdown grezzo. Intestazioni, elenchi, tabelle, link e blocchi di codice vengono tutti renderizzati immediatamente, così puoi individuare errori di formattazione prima che finiscano in un commit.
Scrivere README e Descrizioni di PR
Le descrizioni delle pull request e i file README sono spesso la prima cosa che legge un revisore o un nuovo collaboratore. Verificare che intestazioni, checklist e immagini collegate vengano renderizzate correttamente prima di inviare risparmia un giro di commenti tipo "puoi sistemare la formattazione".
Scrivere Documentazione Offline
Scrivere documentazione su un volo o in una zona con internet inaffidabile non significa rinunciare a vedere la propria formattazione renderizzata correttamente. Uno strumento di anteprima locale funziona allo stesso modo che tu sia connesso o meno.