Halloween sale. Pro for $12 instead of $18 with code TRICKORTF at checkout, until October 31.
Gratis · Modello README incluso

Editor README online gratuito

Parti da un modello di README con le sezioni che le persone cercano e vedilo formattato mentre scrivi: blocchi di codice, tabelle ed elenchi di attività. Scaricalo come README.md quando è pronto.

README.md
FileEditViewInsertFormatHelp
README.md

Nome del progetto

Una frase su cosa fa questo progetto e a chi è rivolto.

Funzionalità

  • Quello che fa meglio, in una riga
  • Il secondo motivo per cui lo si usa
  • Cosa lo rende diverso

Installazione

npm install your-package

Utilizzo

import { start } from "your-package";

start({ verbose: true });

Configurazione

Opzione Predefinito Cosa fa
verbose false Registra ogni passaggio
timeout 3000 Millisecondi prima di arrendersi

Contribuire

Le pull request sono benvenute. Per una modifica importante, apri prima una issue così ne parliamo.

Licenza

MIT

Caricamento dell'editor…Your files stay in your browser
  • I tuoi file non lasciano mai il browser
  • Gratis, senza registrazione
  • Scarica in Markdown, Word, pagina web o PDF
Come funziona

Scrivi un README in tre passaggi

  1. 01

    Parti dal modello

    La pagina si apre su un README.md con le sezioni di sempre: cos'è, funzionalità, installazione, utilizzo, configurazione, come contribuire e licenza.

  2. 02

    Compilalo, formattato

    Sostituisci i segnaposto. I blocchi di codice hanno i colori della sintassi, le tabelle hanno le maniglie e tutto si formatta mentre scrivi.

  3. 03

    Scarica il README.md

    File > Scarica > Markdown (.md) lo salva, pronto per il commit. Oppure File > Copia > Come Markdown e incollalo nell'editor web del tuo repository.

A README.md in the editor with badges, an install command and an options table, downloaded ready to commit
Gratis per Mac e Chrome

Ti piace questo editor? Prova TypeFire.

Lo stesso editor per tutta la tua cartella di note Markdown, più un espansore di testo e un gestore degli appunti. Su Mac, ogni file .md si vede in anteprima nel Finder quando premi Spazio.

Scarica gratis per Mac Aggiungi a Chrome, gratis

Un espansore di testo gratuito, note Markdown e un gestore degli appunti, per Mac e Chrome.

A README.md previewed in Finder with Quick Look on a Mac, after pressing Space
Cosa fa

Tutto ciò che serve a un README

Gli elementi Markdown su cui si reggono i README, formattati mentre scrivi.

Download the README as Markdown, a web page or a PDF from the File menu

  1. Codice delimitato con colori della sintassi

    Comandi di installazione ed esempi d'uso si leggono come codice, nel linguaggio con cui marchi il blocco, con un pulsante di copia su ciascuno.

  2. Tabelle per opzioni e flag

    Le tabelle di configurazione sono la parte di un README che si sbaglia più spesso. Qui aggiungi righe e colonne con un clic.

  3. Elenchi di attività per la roadmap

    - [ ] e - [x] diventano caselle di controllo, come roadmap e checklist appaiono nelle pagine dei repository.

  4. Badge e immagini

    Badge e immagini di altri siti compaiono dopo un clic su Carica immagini, così niente viene caricato dall'esterno finché non lo decidi tu.

  5. Salvato mentre lavori

    La bozza si salva in questo browser mentre scrivi, così puoi tornarci prima del commit.

Vai oltre

Lo stesso editor, senza la scheda del browser

Questo editor viene da TypeFire, un'app gratuita per note Markdown, con espansore di testo e gestore degli appunti. Qui lavora sui file che apri. Nell'app, apre tutta la tua cartella.

TypeFire for Mac with several Markdown notes open in one tab bar

TypeFire per Mac

  • Premi Spazio su qualsiasi file .md nel Finder e leggilo formattato, con Quick Look.
  • Apri una cartella di file Markdown, anche un vault di Obsidian, con schede, ricerca e link.
  • Un espansore di testo e una cronologia degli appunti nella stessa app gratuita.
Scarica gratis per MacScopri l'app per Mac
In a browser email, typing thx and a space expands into a whole thank-you reply

TypeFire per Chrome

  • Questo editor nella sua scheda, a un clic dalla barra degli strumenti.
  • La tua cartella di note .md in schede, con ricerca e link.
  • Un espansore di testo e la cronologia degli appunti su ogni sito.
Aggiungi a Chrome, gratisScopri TypeFire per Chrome

Domande frequenti

Still not answered?

Email usSetup guidePricing

Inizia con una frase su cosa fa il progetto e a chi è rivolto.

Poi funzionalità, installazione, un breve esempio d'uso, configurazione, come contribuire e la licenza. Il modello di questa pagina ha tutto questo come titoli da compilare.

Incolla qui il tuo README.md o trascina il file sulla pagina.

Si formatta mentre lo modifichi, così puoi sistemare titoli, tabelle e blocchi di codice prima del commit.

Mostra ciò che i README usano di più: blocchi di codice delimitati con colori della sintassi, tabelle, elenchi di attività, testo barrato e link automatici.

Un badge è un link a un'immagine: [![testo alternativo](url-immagine)](url-link).

Le immagini di altri siti, come i badge di shields.io, compaiono dopo un clic su Carica immagini nel documento.

Il modello si chiama già README.md, quindi File > Scarica > Markdown (.md) lo salva con quel nome.

Puoi rinominare qualsiasi documento facendo clic sul suo nome in alto. Oppure usa File > Copia > Come Markdown e incollalo nell'editor web del tuo repository.

Sì, senza account e senza registrazione. La tua bozza non viene mai caricata.

Scrivi la riga di intestazione con le barre verticali, sotto una riga di trattini, poi le tue righe.

Oppure usa Inserisci > Tabella e scrivi nelle celle.

Sì. Usa Inserisci > Immagine da un indirizzo web, oppure scrivi ![testo alternativo](https://...) per un'immagine ospitata online.

Sì. Si salva in questo browser mentre scrivi.

File > Scarica > Markdown ti dà il file README.md da committare.

Altri strumenti gratuiti per scrivere e per il Markdown

markdown-viewermarkdown-editor-onlinemarkdown-live-previewopen-md-filemarkdown-cheat-sheetmarkdown-to-pdfmarkdown-to-htmlmarkdown-viewer-windowsmarkdown-table-generatormarkdown-viewer-chromemarkdown-viewer-linuxmarkdown-notepadmarkdown-to-wordmarkdown-converteronline-notepadonline-text-editordistraction-free-writingchatgpt-markdown-to-textword-to-markdowngoogle-docs-to-markdownEspansore di snippet di codice

Scrivi poche lettere, ottieni il codice ripetitivo

Editor Markdown per Mac

Modifica i file .md nei tuoi repository

Guida al Markdown di GitHub

Avvisi, elenchi di attività, note a piè di pagina

Basta riscrivere sempre lo stesso codice ripetitivo

L'espansore di testo di TypeFire trasforma poche lettere nell'intestazione della licenza, nei passaggi di installazione o nel modello di PR, in ogni app. Gratis su Mac.

Scarica gratis per Mac Aggiungi a Chrome, gratis

Un espansore di testo gratuito, note Markdown e un gestore degli appunti, per Mac e Chrome.