Halloween sale. Pro for $12 instead of $18 with code TRICKORTF at checkout, until October 31.
Бесплатно · Шаблон README в комплекте

Бесплатный онлайн-редактор README

Начните с шаблона README с разделами, которые обычно ищут читатели, и видьте форматирование прямо при наборе: блоки кода, таблицы и списки задач. Когда все готово, скачайте файл как README.md.

README.md
FileEditViewInsertFormatHelp
README.md

Название проекта

Одно предложение о том, что делает этот проект и для кого он.

Возможности

  • Что он делает лучше всего, в одной строке
  • Вторая причина, по которой им пользуются
  • Чем он отличается от других

Установка

npm install your-package

Использование

import { start } from "your-package";

start({ verbose: true });

Настройка

Параметр По умолчанию Что делает
verbose false Логирует каждый шаг
timeout 3000 Миллисекунды до отмены

Участие

Pull request приветствуются. Перед крупным изменением сначала откройте issue, чтобы мы могли его обсудить.

Лицензия

MIT

Загрузка редактора…Your files stay in your browser
  • Ваши файлы не покидают браузер
  • Бесплатно, без регистрации
  • Скачивание в Markdown, Word, веб-страницу или PDF
Как это работает

Напишите README за три шага

  1. 01

    Начните с шаблона

    Страница открывается с README.md с привычными разделами: что это, возможности, установка, использование, настройка, участие и лицензия.

  2. 02

    Заполните, уже с форматированием

    Замените заглушки. Блоки кода получают подсветку синтаксиса, таблицы получают маркеры, и все форматируется по ходу набора.

  3. 03

    Скачайте README.md

    Файл > Скачать > Markdown (.md) сохраняет его, готовым к коммиту. Или выберите Файл > Копировать > Как Markdown и вставьте в веб-редактор вашего репозитория.

A README.md in the editor with badges, an install command and an options table, downloaded ready to commit
Бесплатно для Mac и Chrome

Понравился редактор? Установите TypeFire.

Тот же редактор для всей вашей папки с заметками в Markdown, плюс расширитель текста и менеджер буфера обмена. На Mac любой файл .md открывается в предпросмотре в Finder по нажатию пробела.

Бесплатный расширитель текста, заметки в Markdown и менеджер буфера обмена для Mac и Chrome.

A README.md previewed in Finder with Quick Look on a Mac, after pressing Space
Что он умеет

Все, что нужно README

Элементы Markdown, на которых держатся README, с форматированием прямо при наборе.

Download the README as Markdown, a web page or a PDF from the File menu
  1. Огражденный код с подсветкой

    Команды установки и примеры использования выглядят как код, на языке, которым вы пометили блок, и у каждого есть кнопка копирования.

  2. Таблицы для параметров и флагов

    В таблицах настроек README ошибаются чаще всего. Здесь строки и столбцы добавляются одним щелчком.

  3. Списки задач для роадмапа

    - [ ] и - [x] превращаются во флажки, как роадмапы и чек-листы на страницах репозиториев.

  4. Бейджи и изображения

    Бейджи и изображения с других сайтов появляются после одного нажатия Загрузить изображения, так что ничего не загружается извне без вашего согласия.

  5. Сохраняется по ходу работы

    Черновик сохраняется в этом браузере по ходу набора, так что к нему можно вернуться перед коммитом.

Больше возможностей

Тот же редактор, но без вкладки браузера

Этот редактор взят из TypeFire, бесплатного приложения для заметок в Markdown с расширителем текста и менеджером буфера обмена. Здесь он работает с файлами, которые вы открываете. В приложении он открывает всю вашу папку.

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

TypeFire для Mac

  • Нажмите пробел на любом файле .md в Finder и читайте его с форматированием через Quick Look.
  • Откройте папку с Markdown, в том числе хранилище Obsidian, с вкладками, поиском и ссылками.
  • Расширитель текста и история буфера обмена в том же бесплатном приложении.
In a browser email, typing thx and a space expands into a whole thank-you reply

TypeFire для Chrome

  • Этот редактор в отдельной вкладке, в одном клике от панели инструментов.
  • Ваша папка с заметками .md во вкладках, с поиском и ссылками.
  • Расширитель текста и история буфера обмена на любом сайте.

Частые вопросы

Still not answered?

Начните с одного предложения о том, что делает проект и для кого он. Дальше возможности, установка, короткий пример использования, настройка, как поучаствовать и лицензия. В шаблоне на этой странице все это уже есть в виде заголовков для заполнения.

Вставьте сюда свой README.md или перетащите файл на страницу. Он форматируется по ходу правки, так что заголовки, таблицы и блоки кода можно исправить до коммита.

Отображается то, что README используют чаще всего: огражденные блоки кода с подсветкой синтаксиса, таблицы, списки задач, зачеркивание и автоссылки.

Бейдж представляет собой ссылку-изображение: [![альтернативный текст](url-изображения)](url-ссылки). Изображения с других сайтов, например бейджи shields.io, появляются после нажатия Загрузить изображения в документе.

Шаблон уже называется README.md, поэтому Файл > Скачать > Markdown (.md) сохранит его под этим именем. Любой документ можно переименовать, щелкнув по его названию вверху. Или используйте Файл > Копировать > Как Markdown и вставьте в веб-редактор вашего репозитория.

Да, без аккаунта и без регистрации. Ваш черновик никуда не загружается.

Наберите строку заголовков с вертикальными чертами, под ней строку дефисов, а затем свои строки. Или выберите Вставка > Таблица и печатайте в ячейках.

Да. Выберите Вставка > Изображение по веб-адресу или напишите ![альтернативный текст](https://...) для изображения, размещенного в сети.

Да. Он сохраняется в этом браузере по ходу набора. Файл > Скачать > Markdown даст вам файл README.md для коммита.

Хватит снова и снова набирать один и тот же шаблон

Расширитель текста TypeFire превращает пару букв в заголовок лицензии, шаги установки или шаблон PR в любом приложении. Бесплатно на Mac.

Бесплатный расширитель текста, заметки в Markdown и менеджер буфера обмена для Mac и Chrome.