Skip to content

Commit

Permalink
Document scaffolds. Fixes #45.
Browse files Browse the repository at this point in the history
  • Loading branch information
mblayman committed Oct 14, 2015
1 parent f8c91f8 commit 81132ca
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/i18n.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Deployment
Download the ``po`` files. The ``mo`` files are automatically generated with
the ``sdist`` command.

.. code-block:: bash
.. code-block:: console
$ python transifex.py
$ python setup.py sdist
15 changes: 10 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ It is also available for legacy Python
2.7,
and even 2.6.

.. code-block:: bash
.. code-block:: console
$ pip install handroll
Expand All @@ -33,7 +33,7 @@ When inside a website's source directory, the following command will generate
results and store them in ``output``. Use ``handroll -h`` to see all the
options.

.. code-block:: bash
.. code-block:: console
$ handroll
Complete.
Expand All @@ -46,17 +46,21 @@ websites. One goal is to support a wide range of tools to cater to many diverse
interests. The list below isn't exhaustive, but it provides a good idea of
what handroll is capable of doing.

* Copy static assets like CSS or JavaScript.
* Start a new site
with a single command
using :ref:`scaffold`
for immediate results.
* Convert `Markdown <http://daringfireball.net/projects/markdown/>`_ to HTML.
* Convert `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ to
HTML.
* Convert `Textile <http://en.wikipedia.org/wiki/Textile>`_ to HTML.
* Convert `Sass <http://sass-lang.com/>`_ to CSS.
* Copy static assets like CSS or JavaScript.
* Track blog entries and automatically generate a feed
(see :ref:`blogextension`).
* Generate a proper `Atom XML
<http://en.wikipedia.org/wiki/Atom_%28standard%29>`_ feed from metadata
stored in JSON.
* Track blog entries and automatically generate a feed
(see :ref:`blogextension`).
* Run a development server with the ``watch`` flag to monitor your site and
update the output immediately as you make changes (see :ref:`devserver`).
* Find the site source root so you don't have to. If you're anywhere in your
Expand Down Expand Up @@ -86,6 +90,7 @@ Documentation
:maxdepth: 2

configuration
scaffolds
server
composers
extensions
Expand Down
30 changes: 30 additions & 0 deletions docs/scaffolds.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. _scaffold:

Scaffolds
=========

handroll can generate a new site
using a single command.
This will help you get started
in a snap.
After making a site
with the scaffold command,
you can immediately run ``handroll``
to get a functioning website.

.. code-block:: console
$ handroll -s default mysite
Scaffolds can include any content.
The default scaffold includes
a base template,
an index file in Markdown,
a configuration file,
and a sample CSS file.

To list the available scaffolds,

.. code-block:: console
$ handroll -s
2 changes: 1 addition & 1 deletion docs/server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ server will make your site accessible on ``http://localhost:8000``.

Here is an example:

.. code-block:: bash
.. code-block:: console
matt@eden:~/handroll/sample$ handroll -w
Serving /home/matt/handroll/sample/output at http://localhost:8000/.
Expand Down

0 comments on commit 81132ca

Please sign in to comment.