1 | # Docpress
|
2 |
|
3 |
|
4 | > Painless Markdown publishing
|
5 |
|
6 | Documentation website generator.<br>
|
7 | Generates great websites from Markdown files.
|
8 |
|
9 | ![Last version](https://img.shields.io/github/tag/docpress/docpress.svg?style=flat-square)
|
10 | [![Build Status](http://img.shields.io/travis/docpress/docpress/master.svg?style=flat-square)](https://travis-ci.org/docpress/docpress)
|
11 | [![Coverage Status](https://img.shields.io/coveralls/docpress/docpress.svg?style=flat-square)](https://coveralls.io/github/docpress/docpress)
|
12 | [![Dependency status](http://img.shields.io/david/docpress/docpress.svg?style=flat-square)](https://david-dm.org/docpress/docpress)
|
13 | [![Dev Dependencies Status](http://img.shields.io/david/dev/docpress/docpress.svg?style=flat-square)](https://david-dm.org/docpress/docpress#info=devDependencies)
|
14 | [![NPM Status](http://img.shields.io/npm/dm/docpress.svg?style=flat-square)](https://www.npmjs.org/package/docpress)
|
15 |
|
16 | ## Table of Contents
|
17 |
|
18 | * [What is it](#what-is-it)
|
19 | * [Examples](#examples)
|
20 | * [Usage](#usage)
|
21 | * [Support](#support)
|
22 | * [Thanks](#thanks)
|
23 |
|
24 | ## What is it
|
25 |
|
26 | 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/`.
|
27 |
|
28 | Under heavy development now; guides and instructions will magically appear here when we're stable.
|
29 |
|
30 | ## Examples
|
31 |
|
32 | Check out the [Docpress Showcase](docs/showcase.md) to see how Docpress helped developers build great-looking websites.
|
33 |
|
34 | ## Usage
|
35 |
|
36 | Still under heavy development, consider this a preview.
|
37 | Requires Node v8+.
|
38 | See the [Getting Started](docs/getting-started/quickstart.md) guide for more details.
|
39 |
|
40 | ```sh
|
41 | $ npm install -g docpress
|
42 | $ echo "# My project" > README.md
|
43 | $ echo "Documented by Markdown files." >> README.md
|
44 | $ docpress serve
|
45 |
|
46 | Docpress
|
47 | starting development - ^C to exit
|
48 |
|
49 | 350ms ✓ first build
|
50 | on watching changes
|
51 | on livereload
|
52 | on http://localhost:3000
|
53 |
|
54 | Running
|
55 | ```
|
56 |
|
57 | Support
|
58 | -------
|
59 |
|
60 | - [Documentation](http://docpress.github.io/)
|
61 | - [Gitter chat](https://gitter.im/docpress/Lobby)
|
62 |
|
63 | Let's build our first Docpress site.
|
64 | [Quickstart guide →](docs/getting-started/quickstart.md)
|
65 |
|
66 |
|
67 |
|
68 | Thanks
|
69 | ------
|
70 |
|
71 |
|
72 |
|
73 | **docpress** © 2015+, Rico Sta. Cruz. Released under the [MIT] License.<br>
|
74 | Authored and maintained by Rico Sta. Cruz with help from contributors ([list][contributors]).
|
75 |
|
76 |
|
77 |
|
78 | > [ricostacruz.com](http://ricostacruz.com) ·
|
79 | > GitHub [@rstacruz](https://github.com/rstacruz) ·
|
80 | > Twitter [@rstacruz](https://twitter.com/rstacruz)
|
81 |
|
82 |
|
83 |
|
84 | [MIT]: http://mit-license.org/
|
85 | [contributors]: http://github.com/rstacruz/docpress/contributors
|