Halloween sale. Pro for $12 instead of $18 with code TRICKORTF at checkout, until October 31.
Kostenlos · Mit README-Vorlage

Kostenloser README-Editor online

Starten Sie mit einer README-Vorlage, die alle Abschnitte enthält, nach denen Leute suchen, und sehen Sie sie beim Schreiben formatiert: Codeblöcke, Tabellen und Aufgabenlisten. Laden Sie sie als README.md herunter, wenn sie fertig ist.

README.md
FileEditViewInsertFormatHelp
README.md

Projektname

Ein Satz dazu, was dieses Projekt macht und für wen es gedacht ist.

Funktionen

  • Was es am besten kann, in einer Zeile
  • Der zweite Grund, warum Leute es nutzen
  • Was es besonders macht

Installation

npm install your-package

Verwendung

import { start } from "your-package";

start({ verbose: true });

Konfiguration

Option Standard Wirkung
verbose false Protokolliert jeden Schritt
timeout 3000 Millisekunden bis zum Abbruch

Mitwirken

Pull Requests sind willkommen. Für größere Änderungen öffnen Sie bitte zuerst ein Issue, damit wir darüber sprechen können.

Lizenz

MIT

Editor wird geladen…Your files stay in your browser
  • Ihre Dateien verlassen nie Ihren Browser
  • Kostenlos, ohne Anmeldung
  • Download als Markdown, Word, Webseite oder PDF
So funktioniert es

Eine README in drei Schritten schreiben

  1. 01

    Mit der Vorlage starten

    Die Seite öffnet sich mit einer README.md mit den üblichen Abschnitten: Was es ist, Funktionen, Installation, Verwendung, Konfiguration, Mitwirken und Lizenz.

  2. 02

    Ausfüllen, formatiert

    Ersetzen Sie die Platzhalter. Codeblöcke bekommen Syntaxfarben, Tabellen bekommen Griffe, und alles wird beim Tippen dargestellt.

  3. 03

    README.md herunterladen

    Datei > Herunterladen > Markdown (.md) speichert sie, bereit für den Commit. Oder Sie nutzen Datei > Kopieren > Als Markdown und fügen sie im Web-Editor Ihres Repositorys ein.

A README.md in the editor with badges, an install command and an options table, downloaded ready to commit
Kostenlos für Mac und Chrome

Gefällt Ihnen dieser Editor? Holen Sie sich TypeFire.

Derselbe Editor für Ihren ganzen Ordner mit Markdown-Notizen, dazu ein Textbaustein-Tool und ein Zwischenablage-Manager. Auf dem Mac zeigt der Finder jede .md-Datei als Vorschau, sobald Sie die Leertaste drücken.

Kostenlos für Mac laden Zu Chrome hinzufügen, kostenlos

Kostenlose Textbausteine, Markdown-Notizen und ein Zwischenablage-Manager, für Mac und Chrome.

A README.md previewed in Finder with Quick Look on a Mac, after pressing Space
Was es kann

Alles, was eine README braucht

Die Markdown-Elemente, auf die READMEs setzen, formatiert beim Schreiben.

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

  1. Codeblöcke mit Syntaxfarben

    Installationsbefehle und Beispiele lesen sich wie Code, in der Sprache, mit der Sie den Block markieren, und jeder hat einen Kopier-Button.

  2. Tabellen für Optionen und Flags

    Konfigurationstabellen sind der Teil einer README, bei dem am meisten schiefgeht. Hier fügen Sie Zeilen und Spalten mit einem Klick hinzu.

  3. Aufgabenlisten für die Roadmap

    - [ ] und - [x] werden zu Kästchen, so wie Roadmaps und Checklisten auf Repository-Seiten erscheinen.

  4. Badges und Bilder

    Badges und Bilder von anderen Websites erscheinen nach einem Klick auf Bilder laden, es wird also nichts von außen geladen, bevor Sie es erlauben.

  5. Gespeichert, während Sie arbeiten

    Ihr Entwurf wird beim Tippen in diesem Browser gespeichert, Sie können also vor dem Commit darauf zurückkommen.

Noch mehr damit machen

Derselbe Editor, ohne Browser-Tab

Dieser Editor stammt aus TypeFire, einer kostenlosen App für Markdown-Notizen, Textbausteine und die Zwischenablage. Hier arbeitet er mit den Dateien, die Sie öffnen. In der App öffnet er Ihren ganzen Ordner.

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

TypeFire für Mac

  • Drücken Sie im Finder bei einer .md-Datei die Leertaste und lesen Sie sie formatiert, mit Quick Look.
  • Öffnen Sie einen Ordner mit Markdown-Dateien, auch einen Obsidian-Vault, mit Tabs, Suche und Links.
  • Textbausteine und ein Verlauf der Zwischenablage in derselben kostenlosen App.
Kostenlos für Mac ladenZur Mac-App
In a browser email, typing thx and a space expands into a whole thank-you reply

TypeFire für Chrome

  • Dieser Editor in einem eigenen Tab, einen Klick von der Symbolleiste entfernt.
  • Ihr Ordner mit .md-Notizen in Tabs, mit Suche und Links.
  • Textbausteine und Ihr Zwischenablage-Verlauf auf jeder Website.
Zu Chrome hinzufügen, kostenlosZu TypeFire für Chrome

Häufige Fragen

Still not answered?

Email usSetup guidePricing

Beginnen Sie mit einem Satz dazu, was das Projekt macht und für wen es ist.

Dann Funktionen, Installation, ein kurzes Anwendungsbeispiel, Konfiguration, wie man mitwirkt, und die Lizenz. Die Vorlage auf dieser Seite enthält all das als Überschriften zum Ausfüllen.

Fügen Sie Ihre README.md hier ein oder ziehen Sie die Datei auf die Seite.

Sie wird beim Bearbeiten dargestellt, sodass Sie Überschriften, Tabellen und Codeblöcke vor dem Commit korrigieren können.

Es stellt dar, was READMEs am häufigsten nutzen: Codeblöcke mit Syntaxfarben, Tabellen, Aufgabenlisten, Durchstreichung und automatische Links.

Ein Badge ist ein Bild-Link: [![Alt-Text](Bild-URL)](Link-URL).

Bilder von anderen Websites, etwa Badges von shields.io, erscheinen, nachdem Sie im Dokument auf Bilder laden geklickt haben.

Die Vorlage heißt bereits README.md, also speichert Datei > Herunterladen > Markdown (.md) sie unter diesem Namen.

Sie können jedes Dokument umbenennen, indem Sie oben auf seinen Namen klicken. Oder Sie nutzen Datei > Kopieren > Als Markdown und fügen sie im Web-Editor Ihres Repositorys ein.

Ja, ohne Konto und ohne Anmeldung. Ihr Entwurf wird nie hochgeladen.

Tippen Sie die Kopfzeile mit senkrechten Strichen, darunter eine Zeile mit Bindestrichen und dann Ihre Zeilen.

Oder nutzen Sie Einfügen > Tabelle und tippen Sie in die Zellen.

Ja. Nutzen Sie Einfügen > Bild von einer Webadresse oder schreiben Sie ![Alt-Text](https://...) für ein online gehostetes Bild.

Ja. Sie wird beim Tippen in diesem Browser gespeichert.

Datei > Herunterladen > Markdown liefert Ihnen die README.md für den Commit.

Weitere kostenlose Schreib- und Markdown-Tools

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-markdownCode-Snippet-Expander

Ein paar Buchstaben tippen, Boilerplate bekommen

Markdown-Editor für Mac

.md-Dateien in Ihren Repos bearbeiten

GitHub-Markdown-Anleitung

Hinweise, Aufgabenlisten, Fußnoten

Schluss mit dem Abtippen derselben Boilerplate

Die Textbausteine von TypeFire machen aus ein paar Buchstaben Ihren Lizenz-Header, Ihre Installationsschritte oder Ihre PR-Vorlage, in jeder App. Kostenlos auf dem Mac.

Kostenlos für Mac laden Zu Chrome hinzufügen, kostenlos

Kostenlose Textbausteine, Markdown-Notizen und ein Zwischenablage-Manager, für Mac und Chrome.