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?
已存档?
是复刻?
已锁定?
是镜像?
是私有?