-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
101 lines (99 loc) · 5.26 KB
/
index.html
File metadata and controls
101 lines (99 loc) · 5.26 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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name='viewport' content='width=device-width, initial-scale=1' />
<link rel='stylesheet' href='/css/pure-min.css'>
<link rel='stylesheet' href='/screen.css'>
<link href='http://fonts.googleapis.com/css?family=Josefin+Sans:100|Ovo'
rel='stylesheet' type='text/css'>
<title>handroll - A website generator for software artisans</title>
</head>
<body>
<div id='container'>
<div class='hero'>handroll</div>
<div class="pure-menu pure-menu-horizontal">
<a href="/" class="pure-menu-heading pure-menu-link">handroll</a>
<ul class="pure-menu-list">
<li class="pure-menu-item"><a href="/install.html"
class="pure-menu-link">Install</a></li>
</ul>
</div>
<div id='content'>
<p>handroll is a website generator designed to be simple and fast.
You make content in your favorite format
and handroll makes a website out of it.</p>
<p>Want to make a blog using <a href="http://daringfireball.net/projects/markdown/">Markdown</a>? No problem. How about a personal
website in <a href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>? Sure thing. Maybe <a href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">Textile</a> is more
your style. You’re good.</p>
<h2>Quickstart</h2>
<p>Get started fast with these commands!</p>
<div class="codehilite"><pre><span></span><span class="gp">$</span> pip install handroll
<span class="gp">$</span> handroll scaffold default mysite
<span class="go">Complete.</span>
<span class="gp">$</span> handroll watch mysite/source
<span class="go">Serving /Users/matt/mysite at http://localhost:8000/.</span>
<span class="go">Press Ctrl-C to quit.</span>
</pre></div>
<p>For more details, read on
or go to the <a href="/install.html">installation guide</a>.</p>
<h2>Who is this for?</h2>
<p>handroll is for people who want to use plain text editors to make websites.
That group could include programmers, writers, poets, and others.</p>
<p>handroll is a command line tool. In almost all cases, you will only ever need
to type <code>handroll</code>, but a basic comfort level with a command line terminal is
beneficial.</p>
<h2>What can it do?</h2>
<ul>
<li>Make HTML from <a href="http://daringfireball.net/projects/markdown/">Markdown</a>, <a href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>, or
<a href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">Textile</a>.</li>
<li>Make CSS from <a href="http://sass-lang.com/">Sass</a>.</li>
<li><a href="http://handroll.readthedocs.io/en/latest/server.html#devserver">Watch for changes as you work</a>
and automatically update your site.</li>
<li>Track blog entries and <a href="http://handroll.readthedocs.io/en/latest/extensions.html#blog-extension">generate a feed</a>.</li>
<li>Speak
Arabic,
Dutch,
English,
French,
German,
Greek,
Italian,
Portuguese,
and Spanish.</li>
</ul>
<p>You can find a full list of features in the
<a href="http://handroll.readthedocs.io/en/latest/#features">developer documentation</a>.</p>
<h2>How much?</h2>
<p>handroll is free and open source software. That means no cost to you. The tool
is made available under the <a href="https://github.com/handroll/handroll/blob/master/LICENSE">BSD license</a>. In layman’s terms, the
developers aren’t liable for anything.</p>
<h2>Contributing</h2>
<p>There are many ways to contribute to handroll.</p>
<ul>
<li><a href="https://groups.google.com/forum/#!forum/handroll">Start a discussion about a feature</a>.</li>
<li><a href="https://github.com/handroll/handroll/issues">Report a problem you’re experiencing</a>.</li>
<li><a href="http://handroll.readthedocs.io/en/latest/i18n.html">Translate for a new language or fix a broken one</a>.</li>
<li><a href="https://github.com/handroll/handroll/pulls?q=is%3Aopen+is%3Apr">Submit some code you wrote</a>.</li>
<li><a href="http://handroll.readthedocs.io/en/latest/composers.html">Write a plugin for your favorite tool</a>.</li>
<li><a href="http://handroll.readthedocs.io/en/latest/extensions.html">Extend handroll in some new way</a>.</li>
</ul>
<p>The contributions of others will always be appreciated. Contributors of code
or translations are <a href="https://github.com/handroll/handroll/blob/master/AUTHORS">recorded in the source code</a>.</p>
<h2>More information</h2>
<p>Any other information can be found at the various sites used by the handroll
project.</p>
<ul>
<li><a href="https://github.com/handroll/handroll">GitHub project for source code and issues</a></li>
<li><a href="https://pypi.python.org/pypi/handroll">PyPI for package hosting</a></li>
<li><a href="http://handroll.readthedocs.io/en/latest/">Read the Docs for developer documentation</a></li>
<li><a href="https://groups.google.com/forum/#!forum/handroll">Google Group for announcements and discussion</a></li>
<li><a href="https://www.transifex.com/projects/p/handroll/">Transifex project for language translation</a></li>
<li><a href="https://travis-ci.org/handroll/handroll">Travis project for Continuous Integration</a></li>
<li><a href="https://codecov.io/github/handroll/handroll">Codecov for source coverage measurement</a></li>
<li><a href="https://github.com/handroll/handroll.github.io">GitHub project for this website</a></li>
</ul>
</div>
</div>
</body>
</html><!-- handrolled for excellence -->