Halloween sale. Pro for $12 instead of $18 with code TRICKORTF at checkout, until October 31.
Gratuit · Modèle de README inclus

Éditeur de README en ligne gratuit

Partez d'un modèle de README avec les sections que les gens cherchent, et voyez-le mis en forme pendant que vous écrivez : blocs de code, tableaux et listes de tâches. Téléchargez-le en README.md quand il est prêt.

README.md
FileEditViewInsertFormatHelp
README.md

Nom du projet

Une phrase sur ce que fait ce projet et à qui il s'adresse.

Fonctionnalités

  • Ce qu'il fait le mieux, en une ligne
  • La deuxième raison pour laquelle on l'utilise
  • Ce qui le rend différent

Installation

npm install your-package

Utilisation

import { start } from "your-package";

start({ verbose: true });

Configuration

Option Par défaut Effet
verbose false Journalise chaque étape
timeout 3000 Millisecondes avant abandon

Contribuer

Les pull requests sont les bienvenues. Pour un changement important, ouvrez d'abord une issue pour qu'on en discute.

Licence

MIT

Chargement de l'éditeur…Your files stay in your browser
  • Vos fichiers ne quittent jamais votre navigateur
  • Gratuit, sans inscription
  • Téléchargement en Markdown, Word, page web ou PDF
Comment ça marche

Écrire un README en trois étapes

  1. 01

    Partez du modèle

    La page s'ouvre sur un README.md avec les sections habituelles : présentation, fonctionnalités, installation, utilisation, configuration, contribution et licence.

  2. 02

    Remplissez-le, mis en forme

    Remplacez les textes d'exemple. Les blocs de code ont la coloration syntaxique, les tableaux ont des poignées, et tout s'affiche pendant que vous tapez.

  3. 03

    Téléchargez README.md

    Fichier > Télécharger > Markdown (.md) l'enregistre, prêt à committer. Ou Fichier > Copier > En Markdown, puis collez-le dans l'éditeur web de votre dépôt.

A README.md in the editor with badges, an install command and an options table, downloaded ready to commit
Gratuit pour Mac et Chrome

Cet éditeur vous plaît ? Passez à TypeFire.

Le même éditeur pour tout votre dossier de notes Markdown, avec un expanseur de texte et un gestionnaire de presse-papiers. Sur Mac, chaque fichier .md s'affiche en aperçu dans le Finder quand vous appuyez sur Espace.

Télécharger gratuitement pour Mac Ajouter à Chrome, c'est gratuit

Un expanseur de texte gratuit, des notes Markdown et un gestionnaire de presse-papiers, pour Mac et Chrome.

A README.md previewed in Finder with Quick Look on a Mac, after pressing Space
Ce qu'il fait

Tout ce qu'il faut à un README

Les éléments Markdown sur lesquels reposent les README, mis en forme pendant que vous écrivez.

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

  1. Code délimité avec coloration syntaxique

    Commandes d'installation et exemples d'utilisation se lisent comme du code, dans le langage indiqué sur le bloc, avec un bouton de copie sur chacun.

  2. Des tableaux pour les options et les flags

    Les tableaux de configuration sont la partie d'un README que l'on rate le plus. Ici, vous ajoutez lignes et colonnes d'un clic.

  3. Des listes de tâches pour la feuille de route

    - [ ] et - [x] deviennent des cases à cocher, comme les feuilles de route et listes de contrôle sur les pages de dépôt.

  4. Badges et images

    Les badges et images d'autres sites s'affichent après un clic sur Charger les images : rien ne se charge depuis l'extérieur sans votre accord.

  5. Enregistré pendant que vous travaillez

    Votre brouillon est enregistré dans ce navigateur pendant que vous tapez, pour y revenir avant de committer.

Pour aller plus loin

Le même éditeur, sans l'onglet du navigateur

Cet éditeur vient de TypeFire, une app gratuite pour les notes Markdown, avec un expanseur de texte et un gestionnaire de presse-papiers. Ici, il travaille sur les fichiers que vous ouvrez. Dans l'app, il ouvre tout votre dossier.

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

TypeFire pour Mac

  • Appuyez sur Espace sur n'importe quel fichier .md dans le Finder et lisez-le mis en forme, avec Quick Look.
  • Ouvrez un dossier de fichiers Markdown, y compris un coffre Obsidian, avec onglets, recherche et liens.
  • Un expanseur de texte et un historique du presse-papiers dans la même app gratuite.
Télécharger gratuitement pour MacDécouvrir l'app Mac
In a browser email, typing thx and a space expands into a whole thank-you reply

TypeFire pour Chrome

  • Cet éditeur dans son propre onglet, à un clic de la barre d'outils.
  • Votre dossier de notes .md en onglets, avec recherche et liens.
  • Un expanseur de texte et votre historique du presse-papiers sur tous les sites.
Ajouter à Chrome, c'est gratuitDécouvrir TypeFire pour Chrome

Questions fréquentes

Still not answered?

Email usSetup guidePricing

Commencez par une phrase sur ce que fait le projet et à qui il s'adresse.

Puis les fonctionnalités, l'installation, un court exemple d'utilisation, la configuration, comment contribuer et la licence. Le modèle de cette page contient tout cela sous forme de titres à remplir.

Collez votre README.md ici ou déposez le fichier sur la page.

Il s'affiche pendant que vous le modifiez, pour corriger titres, tableaux et blocs de code avant de committer.

L'éditeur affiche ce que les README utilisent le plus : blocs de code délimités avec coloration syntaxique, tableaux, listes de tâches, texte barré et liens automatiques.

Un badge est un lien image : [![texte alternatif](url-image)](url-lien).

Les images d'autres sites, comme les badges shields.io, s'affichent après un clic sur Charger les images dans le document.

Le modèle s'appelle déjà README.md, donc Fichier > Télécharger > Markdown (.md) l'enregistre sous ce nom.

Vous pouvez renommer n'importe quel document en cliquant sur son nom en haut. Ou utilisez Fichier > Copier > En Markdown et collez-le dans l'éditeur web de votre dépôt.

Oui, sans compte et sans inscription. Votre brouillon n'est jamais envoyé.

Tapez la ligne d'en-tête avec des barres verticales, une ligne de tirets en dessous, puis vos lignes.

Ou utilisez Insertion > Tableau et tapez dans les cellules.

Oui. Utilisez Insertion > Image depuis une adresse web, ou écrivez ![texte alternatif](https://...) pour une image hébergée en ligne.

Oui. Il est enregistré dans ce navigateur pendant que vous tapez.

Fichier > Télécharger > Markdown vous donne le fichier README.md à committer.

Plus d'outils gratuits d'écriture et de 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-markdownExpanseur d'extraits de code

Quelques lettres, et le code type arrive

Éditeur Markdown pour Mac

Modifier les .md de vos dépôts

Guide du Markdown GitHub

Alertes, listes de tâches, notes de bas de page

Arrêtez de retaper le même code type

L'expanseur de texte de TypeFire transforme quelques lettres en en-tête de licence, étapes d'installation ou modèle de PR, dans toutes les apps. Gratuit sur Mac.

Télécharger gratuitement pour Mac Ajouter à Chrome, c'est gratuit

Un expanseur de texte gratuit, des notes Markdown et un gestionnaire de presse-papiers, pour Mac et Chrome.