docpress

Documentation website generator

Github星跟蹤圖

Docpress

Painless Markdown publishing

Documentation website generator.
Generates great websites from Markdown files.

Last version
Build Status
Coverage Status
Dependency status
Dev Dependencies Status
NPM Status

Table of Contents

What is it

Docpress generates websites from your project's basic documentation; that is, at the very least, a README.md file. It also supports multiple Markdown pages in docs/.

Under heavy development now; guides and instructions will magically appear here when we're stable.

Examples

Check out the Docpress Showcase to see how Docpress helped developers build great-looking websites.

Usage

Still under heavy development, consider this a preview.
Requires Node v8+.
See the Getting Started guide for more details.

$ 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

Support

Let's build our first Docpress site.
Quickstart guide →

Thanks

docpress © 2015+, Rico Sta. Cruz. Released under the MIT License.
Authored and maintained by Rico Sta. Cruz with help from contributors (list).

ricostacruz.com  · 
GitHub @rstacruz  · 
Twitter @rstacruz

主要指標

概覽
名稱與所有者docpress/docpress
主編程語言JavaScript
編程語言JavaScript (語言數: 1)
平台
許可證
所有者活动
創建於2015-10-05 14:55:32
推送於2023-02-28 04:14:20
最后一次提交2022-01-27 10:58:48
發布數42
最新版本名稱v0.8.2 (發布於 2020-07-05 16:30:54)
第一版名稱v0.1.0 (發布於 2015-10-11 23:57:19)
用户参与
星數885
關注者數15
派生數75
提交數260
已啟用問題?
問題數54
打開的問題數27
拉請求數68
打開的拉請求數6
關閉的拉請求數146
项目设置
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?