-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathindex.html
More file actions
157 lines (153 loc) · 9.21 KB
/
Copy pathindex.html
File metadata and controls
157 lines (153 loc) · 9.21 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<link rel="stylesheet" href="assets/style.css?t=90051322">
<link rel="stylesheet" href="http://ricostacruz.com/docpress-rsc/style.css">
<link rel="stylesheet" href="assets/custom.css?t=202a34cf">
<script src="assets/script.js?t=93f1a66c"></script>
<title>docpress</title>
<meta name="viewport" content="width=device-width">
<script>if (false || window.location.hostname.indexOf("docpress.github.io") === window.location.hostname.length - 18) {
(function(d,o,c,p,r,e,s){d['GoogleAnalyticsObject']=r;d[r]=d[r]||function(){(d[r].q=d[r].q||[]).push(arguments)},d[r].l=1*new Date();e=o.createElement(c),s=o.getElementsByTagName(c)[0];e.async=1;e.src=p;s.parentNode.insertBefore(e,s)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create',"UA-70057942-1",'auto')
}
</script>
</head>
<body class="-menu-visible">
<div class="doc-layout">
<div class="toggle menu-toggle js-menu-toggle"></div>
<div class="menu toc-menu">
<ul>
<li class="menu-item -level-0 -parent">
<ul class="submenu">
<li class="menu-item -level-1"><a class="link title -active link-index" href="index.html">docpress</a>
<ul class="headings heading-list">
<li class="heading-item -depth-2"><a class="hlink link-table-of-contents" href="#table-of-contents">Table of Contents</a>
</li>
<li class="heading-item -depth-2"><a class="hlink link-what-is-it" href="#what-is-it">What is it</a>
</li>
<li class="heading-item -depth-2"><a class="hlink link-examples" href="#examples">Examples</a>
</li>
<li class="heading-item -depth-2"><a class="hlink link-usage" href="#usage">Usage</a>
</li>
<li class="heading-item -depth-2"><a class="hlink link-support" href="#support">Support</a>
</li>
<li class="heading-item -depth-2"><a class="hlink link-thanks" href="#thanks">Thanks</a>
</li>
</ul>
</li>
<li class="menu-item -level-1"><a class="link title link-showcase" href="showcase.html">Showcase</a>
</li>
<li class="menu-item -level-1 -parent"><span class="title">Getting started</span>
<ul class="submenu">
<li class="menu-item -level-2"><a class="link title link-getting-startedquickstart" href="getting-started/quickstart.html">Quick-start guide</a>
</li>
<li class="menu-item -level-2"><a class="link title link-getting-startedmore-pages" href="getting-started/more-pages.html">Writing more pages</a>
</li>
<li class="menu-item -level-2"><a class="link title link-getting-startedimages-and-linking" href="getting-started/images-and-linking.html">Images and linking</a>
</li>
<li class="menu-item -level-2"><a class="link title link-getting-startedtables" href="getting-started/tables.html">Create tables</a>
</li>
</ul>
</li>
<li class="menu-item -level-1 -parent"><span class="title">Customization</span>
<ul class="submenu">
<li class="menu-item -level-2"><a class="link title link-customizationconfig" href="customization/config.html">Configuration</a>
</li>
<li class="menu-item -level-2"><a class="link title link-customizationcss" href="customization/css.html">Custom CSS</a>
</li>
<li class="menu-item -level-2"><a class="link title link-customizationscripts" href="customization/scripts.html">Custom Scripts</a>
</li>
<li class="menu-item -level-2"><a class="link title link-customizationplugins" href="customization/plugins.html">Using plugins</a>
</li>
<li class="menu-item -level-2"><a class="link title link-customizationmarkdown" href="customization/markdown.html">Markdown configuration</a>
</li>
<li class="menu-item -level-2"><a class="link title link-customizationanalytics" href="customization/analytics.html">Google Analytics</a>
</li>
<li class="menu-item -level-2"><a class="link title link-customizationdisqus" href="customization/disqus.html">Disqus</a>
</li>
</ul>
</li>
<li class="menu-item -level-1 -parent"><span class="title">Advanced</span>
<ul class="submenu">
<li class="menu-item -level-2"><a class="link title link-advancedgh-pages" href="advanced/gh-pages.html">Automating GitHub pages</a>
</li>
<li class="menu-item -level-2"><a class="link title link-advancedhacking" href="advanced/hacking.html">Hacking Docpress</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="body page-index">
<div class="header-nav">
<div class="right"><a class="iconlink" href="https://github.com/docpress/docpress" data-title="docpress/docpress">
<!-- span.title Open in GitHub--><span class="icon -github"></span></a>
</div>
</div>
<div class="markdown-body"><h1 class="massive-header -with-tagline" id="docpress">Docpress</h1>
<blockquote>
<p>Painless Markdown publishing</p>
</blockquote>
<p>Documentation website generator.<br>
Generates great websites from Markdown files.</p>
<p><img src="https://img.shields.io/github/tag/docpress/docpress.svg?style=flat-square" alt="Last version">
<a href="https://travis-ci.org/docpress/docpress"><img src="http://img.shields.io/travis/docpress/docpress/master.svg?style=flat-square" alt="Build Status"></a>
<a href="https://coveralls.io/github/docpress/docpress"><img src="https://img.shields.io/coveralls/docpress/docpress.svg?style=flat-square" alt="Coverage Status"></a>
<a href="https://david-dm.org/docpress/docpress"><img src="http://img.shields.io/david/docpress/docpress.svg?style=flat-square" alt="Dependency status"></a>
<a href="https://david-dm.org/docpress/docpress#info=devDependencies"><img src="http://img.shields.io/david/dev/docpress/docpress.svg?style=flat-square" alt="Dev Dependencies Status"></a>
<a href="https://www.npmjs.org/package/docpress"><img src="http://img.shields.io/npm/dm/docpress.svg?style=flat-square" alt="NPM Status"></a></p>
<h2 id="table-of-contents">Table of Contents</h2>
<ul>
<li><a href="#what-is-it">What is it</a></li>
<li><a href="#examples">Examples</a></li>
<li><a href="#usage">Usage</a></li>
<li><a href="#support">Support</a></li>
<li><a href="#thanks">Thanks</a></li>
</ul>
<h2 id="what-is-it">What is it</h2>
<p>Docpress generates websites from your project’s basic documentation; that is, at the very least, a <code>README.md</code> file. It also supports multiple Markdown pages in <code>docs/</code>.</p>
<p>Under heavy development now; guides and instructions will magically appear here when we’re stable.</p>
<h2 id="examples">Examples</h2>
<p>Check out the <a href="showcase.html">Docpress Showcase</a> to see how Docpress helped developers build great-looking websites.</p>
<h2 id="usage">Usage</h2>
<p>Still under heavy development, consider this a preview.
Requires Node v8+.
See the <a href="getting-started/quickstart.html">Getting Started</a> guide for more details.</p>
<pre><code class="lang-sh">$ npm install -g docpress
$ <span class="pl-c1">echo</span> <span class="pl-s">"# My project"</span> > README.md
$ <span class="pl-c1">echo</span> <span class="pl-s">"Documented by Markdown files."</span> >> README.md
$ docpress serve
Docpress
starting development - ^C to <span class="pl-c1">exit</span>
350ms ✓ first build
on watching changes
on livereload
on http://localhost:3000
Running
</code></pre>
<h2 id="support">Support</h2>
<ul>
<li><a href="http://docpress.github.io/">Documentation</a></li>
<li><a href="https://gitter.im/docpress/Lobby">Gitter chat</a></li>
</ul>
<p class="pull-box">Let’s build our first Docpress site.
<a href="getting-started/quickstart.html">Quickstart guide →</a></p>
<h2 style="display:none" id="thanks">Thanks</h2>
<p style="display:none"><strong>docpress</strong> © 2015+, Rico Sta. Cruz. Released under the <a href="http://mit-license.org/">MIT</a> License.<br>
Authored and maintained by Rico Sta. Cruz with help from contributors (<a href="http://github.com/rstacruz/docpress/contributors">list</a>).</p>
<blockquote style="display:none">
<p><a href="http://ricostacruz.com">ricostacruz.com</a>  · 
GitHub <a href="https://github.com/rstacruz">@rstacruz</a>  · 
Twitter <a href="https://twitter.com/rstacruz">@rstacruz</a></p>
</blockquote>
</div>
<div class="footer-nav">
<div class="right"><a href="showcase.html"><span class="label">Next: </span><span class="title">Showcase</span></a></div>
</div>
</div>
</div>
</body>
</html>