Mercurial > piecrust2

annotate README.rst @ 1145:e94737572542

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
serve: Fix an issue where false positive matches were rendered as the requested page. Now we try to render the page, but also try to detect for the most common "empty" pages.
author Ludovic Chabant <ludovic@chabant.com>
date Tue, 05 Jun 2018 22:08:51 -0700
parents 477dc9a63222
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
1
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
2 PieCrust is a static website generator and lightweight CMS that's all managed
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
3 with text files. No complex setup, databases, or administrative panels.
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
4 Simple, beautiful, and yummy.
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
5
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
6 For more information, along with the complete documentation, visit `the
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
7 official website`_.
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
8
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
9 .. _the official website: http://bolt80.com/piecrust/
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
10
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
11
618
477dc9a63222 cm: Add some pretty little icons in the README.
Ludovic Chabant <ludovic@chabant.com>
parents: 160
diff changeset
12 |pypi-version| |pypi-downloads| |build-status|
477dc9a63222 cm: Add some pretty little icons in the README.
Ludovic Chabant <ludovic@chabant.com>
parents: 160
diff changeset
13
477dc9a63222 cm: Add some pretty little icons in the README.
Ludovic Chabant <ludovic@chabant.com>
parents: 160
diff changeset
14 .. |pypi-version| image:: https://img.shields.io/pypi/v/piecrust.svg
477dc9a63222 cm: Add some pretty little icons in the README.
Ludovic Chabant <ludovic@chabant.com>
parents: 160
diff changeset
15 :target: https://pypi.python.org/pypi/piecrust
477dc9a63222 cm: Add some pretty little icons in the README.
Ludovic Chabant <ludovic@chabant.com>
parents: 160
diff changeset
16 :alt: PyPI: the Python Package Index
477dc9a63222 cm: Add some pretty little icons in the README.
Ludovic Chabant <ludovic@chabant.com>
parents: 160
diff changeset
17 .. |pypi-downloads| image:: https://img.shields.io/pypi/dm/piecrust.svg
477dc9a63222 cm: Add some pretty little icons in the README.
Ludovic Chabant <ludovic@chabant.com>
parents: 160
diff changeset
18 :target: https://pypi.python.org/pypi/piecrust
477dc9a63222 cm: Add some pretty little icons in the README.
Ludovic Chabant <ludovic@chabant.com>
parents: 160
diff changeset
19 :alt: PyPI: the Python Package Index
477dc9a63222 cm: Add some pretty little icons in the README.
Ludovic Chabant <ludovic@chabant.com>
parents: 160
diff changeset
20 .. |build-status| image:: https://img.shields.io/travis/ludovicchabant/PieCrust2/master.svg
477dc9a63222 cm: Add some pretty little icons in the README.
Ludovic Chabant <ludovic@chabant.com>
parents: 160
diff changeset
21 :target: https://travis-ci.org/ludovicchabant/PieCrust2
477dc9a63222 cm: Add some pretty little icons in the README.
Ludovic Chabant <ludovic@chabant.com>
parents: 160
diff changeset
22 :alt: Travis CI: continuous integration status
477dc9a63222 cm: Add some pretty little icons in the README.
Ludovic Chabant <ludovic@chabant.com>
parents: 160
diff changeset
23
477dc9a63222 cm: Add some pretty little icons in the README.
Ludovic Chabant <ludovic@chabant.com>
parents: 160
diff changeset
24
477dc9a63222 cm: Add some pretty little icons in the README.
Ludovic Chabant <ludovic@chabant.com>
parents: 160
diff changeset
25
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
26 Quickstart
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
27 ==========
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
28
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
29 If you want to quickly give it a spin:
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
30
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
31 ::
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
32
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
33 pip install piecrust
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
34 chef init mywebsite
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
35 cd mywebsite
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
36 chef serve
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
37
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
38 It should create a new empty site in a ``mywebsite`` folder, and start a small
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
39 web server to preview it. You can then point your browser to ``localhost:8080``
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
40 to see the default home page.
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
41
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
42 Use ``chef prepare page`` and ``chef prepare post`` to create pages and posts,
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
43 and edit those in your favorite text editor.
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
44
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
45 When you're happy, run ``chef bake`` to generate the final static website,
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
46 which you'll find in ``_counter``. At this point you can upload the contents of
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
47 ``_counter`` to your server.
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
48
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
49
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
50 Changes
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
51 =======
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
52
160
de09d41bae23 Moved all installation instructions to a new `INSTALL` file.
Ludovic Chabant <ludovic@chabant.com>
parents: 134
diff changeset
53 Check out the ``CHANGELOG`` file for new features, bug fixes and breaking
de09d41bae23 Moved all installation instructions to a new `INSTALL` file.
Ludovic Chabant <ludovic@chabant.com>
parents: 134
diff changeset
54 changes. You can `see it online here <https://bitbucket.org/ludovicchabant/piecrust2/raw/default/CHANGELOG.rst>`__.
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
55
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
56
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
57 Installation
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
58 ============
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
59
160
de09d41bae23 Moved all installation instructions to a new `INSTALL` file.
Ludovic Chabant <ludovic@chabant.com>
parents: 134
diff changeset
60 You can install PieCrust like any other package:
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
61
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
62 ::
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
63
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
64 pip install piecrust
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
65
160
de09d41bae23 Moved all installation instructions to a new `INSTALL` file.
Ludovic Chabant <ludovic@chabant.com>
parents: 134
diff changeset
66 For more options to get PieCrust on your machine, see the ``INSTALL`` file. You
de09d41bae23 Moved all installation instructions to a new `INSTALL` file.
Ludovic Chabant <ludovic@chabant.com>
parents: 134
diff changeset
67 can `see it online here <https://bitbucket.org/ludovicchabant/piecrust2/raw/default/INSTALL.rst>`__.
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
68