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

Gratis online README-editor

Begin met een README-sjabloon met de onderdelen waar mensen naar zoeken, en zie hem opgemaakt terwijl u schrijft: codeblokken, tabellen en takenlijsten. Download hem als README.md wanneer hij klaar is.

README.md
FileEditViewInsertFormatHelp
README.md

Projectnaam

Eén zin over wat dit project doet en voor wie het is.

Functies

  • Waar het het best in is, in één regel
  • De tweede reden waarom mensen het gebruiken
  • Wat het anders maakt

Installatie

npm install your-package

Gebruik

import { start } from "your-package";

start({ verbose: true });

Configuratie

Optie Standaard Wat het doet
verbose false Logt elke stap
timeout 3000 Milliseconden voordat het opgeeft

Bijdragen

Pull requests zijn welkom. Open voor een grote wijziging eerst een issue, zodat we het kunnen bespreken.

Licentie

MIT

Editor wordt geladen…Your files stay in your browser
  • Uw bestanden verlaten nooit uw browser
  • Gratis, zonder account
  • Download als Markdown, Word, webpagina of PDF
Zo werkt het

Schrijf een README in drie stappen

  1. 01

    Begin met de sjabloon

    De pagina opent met een README.md met de gebruikelijke onderdelen: wat het is, functies, installatie, gebruik, configuratie, bijdragen en licentie.

  2. 02

    Vul hem in, opgemaakt

    Vervang de plaatsaanduidingen. Codeblokken krijgen syntaxkleuren, tabellen krijgen grepen en alles wordt opgemaakt terwijl u typt.

  3. 03

    README.md downloaden

    Bestand > Downloaden > Markdown (.md) bewaart hem, klaar voor de commit. Of gebruik Bestand > Kopiëren > Als Markdown en plak hem in de webeditor van uw repository.

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

Bevalt deze editor? Neem TypeFire.

Dezelfde editor voor uw hele map met Markdown-notities, plus een tekstexpander en een klembordbeheerder. Op een Mac ziet u elk .md-bestand als voorvertoning in de Finder zodra u op de spatiebalk drukt.

Een gratis tekstexpander, Markdown-notities en een klembordbeheerder, voor Mac en Chrome.

A README.md previewed in Finder with Quick Look on a Mac, after pressing Space
Wat het doet

Alles wat een README nodig heeft

De Markdown-onderdelen waar README's op leunen, opgemaakt terwijl u schrijft.

Download the README as Markdown, a web page or a PDF from the File menu
  1. Afgebakende code met syntaxkleuren

    Installatiecommando's en gebruiksvoorbeelden lezen als code, in de taal waarmee u het blok markeert, met een kopieerknop bij elk blok.

  2. Tabellen voor opties en flags

    Configuratietabellen zijn het deel van een README dat het vaakst misgaat. Hier voegt u rijen en kolommen toe met één klik.

  3. Takenlijsten voor de roadmap

    - [ ] en - [x] worden selectievakjes, zoals roadmaps en checklists op repositorypagina's verschijnen.

  4. Badges en afbeeldingen

    Badges en afbeeldingen van andere sites verschijnen na één klik op Afbeeldingen laden, dus er wordt niets van buiten geladen totdat u dat zegt.

  5. Bewaard terwijl u werkt

    Uw concept wordt in deze browser bewaard terwijl u typt, zodat u er vóór de commit naar kunt terugkeren.

Ga verder

Dezelfde editor, zonder browsertabblad

Deze editor komt uit TypeFire, een gratis app voor Markdown-notities, met een tekstexpander en een klembordbeheerder. Hier werkt hij met de bestanden die u opent. In de app opent hij uw hele map.

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

TypeFire voor Mac

  • Druk in de Finder op de spatiebalk bij een .md-bestand en lees het opgemaakt, met Quick Look.
  • Open een map met Markdown, ook een Obsidian-vault, met tabbladen, zoeken en links.
  • Een tekstexpander en een klembordgeschiedenis in dezelfde gratis app.
In a browser email, typing thx and a space expands into a whole thank-you reply

TypeFire voor Chrome

  • Deze editor in een eigen tabblad, één klik vanaf de werkbalk.
  • Uw map met .md-notities in tabbladen, met zoeken en links.
  • Een tekstexpander en uw klembordgeschiedenis op elke website.

Veelgestelde vragen

Still not answered?

Begin met één zin over wat het project doet en voor wie het is.

Daarna functies, installatie, een kort gebruiksvoorbeeld, configuratie, hoe u kunt bijdragen en de licentie. De sjabloon op deze pagina heeft dat allemaal als koppen om in te vullen.

Plak uw README.md hier of sleep het bestand naar de pagina.

Hij wordt opgemaakt terwijl u bewerkt, zodat u koppen, tabellen en codeblokken vóór de commit kunt verbeteren.

Het toont wat README's het meest gebruiken: afgebakende codeblokken met syntaxkleuren, tabellen, takenlijsten, doorhalen en automatische links.

Een badge is een afbeeldingslink: [![alt-tekst](afbeeldings-url)](link-url).

Afbeeldingen van andere sites, zoals badges van shields.io, verschijnen nadat u in het document op Afbeeldingen laden klikt.

De sjabloon heet al README.md, dus Bestand > Downloaden > Markdown (.md) bewaart hem onder die naam.

U kunt elk document hernoemen door bovenaan op de naam te klikken. Of gebruik Bestand > Kopiëren > Als Markdown en plak hem in de webeditor van uw repository.

Ja, zonder account en zonder aanmelding. Uw concept wordt nooit geüpload.

Typ de kopregel met sluistekens, daaronder een regel streepjes en dan uw rijen.

Of gebruik Invoegen > Tabel en typ in de cellen.

Ja. Gebruik Invoegen > Afbeelding van een webadres, of schrijf ![alt-tekst](https://...) voor een online gehoste afbeelding.

Ja. Hij wordt in deze browser bewaard terwijl u typt.

Bestand > Downloaden > Markdown geeft u het README.md-bestand om te committen.

Stop met steeds dezelfde standaardcode typen

De tekstexpander van TypeFire maakt van een paar letters uw licentiekop, installatiestappen of PR-sjabloon, in elke app. Gratis op de Mac.

Een gratis tekstexpander, Markdown-notities en een klembordbeheerder, voor Mac en Chrome.