docpress

Допресс

Безболезненная публикация Markdown

Генератор сайта документации.
Создает отличные веб-сайты из файлов Markdown.

Оглавление

• Что это такое
• Примеры
• Использование
• Поддерживать
• Спасибо

Что это такое

Docpress создает веб-сайты на основе базовой документации вашего проекта; то есть, по крайней мере, файл README.md . Он также поддерживает несколько страниц Markdown в docs/ .

Сейчас интенсивно развивается; руководства и инструкции волшебным образом появятся здесь, когда мы стабилизируемся.

Примеры

Посетите Docpress Showcase, чтобы узнать, как Docpress помог разработчикам создавать великолепные веб-сайты.

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

Все еще находится в стадии активной разработки, считайте это предварительной версией. Требуется Node v8+. Дополнительные сведения см. в руководстве «Приступая к работе».

$ npm install -g docpress
$ echo " # My project " > README.md
$ echo " Documented by Markdown files. " >> README.md
$ docpress serve

  Docpress
  starting development - ^C to exit

  350ms ✓   first build                 
      on    watching changes
      on    livereload
      on    http://localhost:3000

  Running

Поддерживать

• Документация
• Гиттер чат

Давайте создадим наш первый сайт Docpress. Краткое руководство →

Спасибо

docpress © 2015+, Рико Ста. Круз. Выпущено по лицензии MIT.
Автор и поддерживается Рико Ста. Круз с помощью авторов (список).

ricostacruz.com · GitHub @rstacruz · Twitter @rstacruz