docpress

Documentation website generator

Github stars Tracking Chart

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

Main metrics

Overview
Name With Ownerdocpress/docpress
Primary LanguageJavaScript
Program languageJavaScript (Language Count: 1)
Platform
License:
所有者活动
Created At2015-10-05 14:55:32
Pushed At2023-02-28 04:14:20
Last Commit At2022-01-27 10:58:48
Release Count42
Last Release Namev0.8.2 (Posted on 2020-07-05 16:30:54)
First Release Namev0.1.0 (Posted on 2015-10-11 23:57:19)
用户参与
Stargazers Count885
Watchers Count15
Fork Count77
Commits Count260
Has Issues Enabled
Issues Count54
Issue Open Count27
Pull Requests Count68
Pull Requests Open Count6
Pull Requests Close Count146
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private