https://github.com/docpress/docpress

Documentation website generator
https://github.com/docpress/docpress

docpress documentation markdown markdown-to-html static-site

Last synced: 5 days ago
JSON representation

Documentation website generator

• Host: GitHub
• URL: https://github.com/docpress/docpress
• Owner: docpress
• Created: 2015-10-05T14:55:32.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-02-28T04:14:20.000Z (over 1 year ago)
• Last Synced: 2024-04-14T09:05:12.771Z (7 months ago)
• Topics: docpress, documentation, markdown, markdown-to-html, static-site
• Language: JavaScript
• Homepage: http://docpress.github.io/
• Size: 777 KB
• Stars: 888
• Watchers: 16
• Forks: 80
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

• project-awesome - docpress/docpress - Documentation website generator (JavaScript)
• awesome-starred - docpress/docpress - Documentation website generator (markdown)

README

        
# Docpress

> Painless Markdown publishing

Documentation website generator.


Generates great websites from Markdown files.

![Last version](https://img.shields.io/github/tag/docpress/docpress.svg?style=flat-square)

[![Build Status](http://img.shields.io/travis/docpress/docpress/master.svg?style=flat-square)](https://travis-ci.org/docpress/docpress)

[![Coverage Status](https://img.shields.io/coveralls/docpress/docpress.svg?style=flat-square)](https://coveralls.io/github/docpress/docpress)

[![Dependency status](http://img.shields.io/david/docpress/docpress.svg?style=flat-square)](https://david-dm.org/docpress/docpress)

[![Dev Dependencies Status](http://img.shields.io/david/dev/docpress/docpress.svg?style=flat-square)](https://david-dm.org/docpress/docpress#info=devDependencies)

[![NPM Status](http://img.shields.io/npm/dm/docpress.svg?style=flat-square)](https://www.npmjs.org/package/docpress)

## Table of Contents

* [What is it](#what-is-it)

* [Examples](#examples)

* [Usage](#usage)

* [Support](#support)

* [Thanks](#thanks)

## 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](docs/showcase.md) 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](docs/getting-started/quickstart.md) guide for more details.

```sh

$ 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

-------

- [Documentation](http://docpress.github.io/)

- [Gitter chat](https://gitter.im/docpress/Lobby)

Let's build our first Docpress site.

[Quickstart guide →](docs/getting-started/quickstart.md)

Thanks

------

**docpress** © 2015+, Rico Sta. Cruz. Released under the [MIT] License.


Authored and maintained by Rico Sta. Cruz with help from contributors ([list][contributors]).

> [ricostacruz.com](http://ricostacruz.com)  · 

> GitHub [@rstacruz](https://github.com/rstacruz)  · 

> Twitter [@rstacruz](https://twitter.com/rstacruz)

[MIT]: http://mit-license.org/

[contributors]: http://github.com/rstacruz/docpress/contributors