Mercurial > piecrust2

annotate README.rst @ 170:c3831a762bc2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. The `SimplePageSource` now calls a `_populateMetadata` function that subclasses can override to add/edit their custom metadata everwhere it would be returned to the system.
author Ludovic Chabant <ludovic@chabant.com>
date Sat, 03 Jan 2015 20:49:00 -0800
parents de09d41bae23
children 477dc9a63222
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
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
12 Quickstart
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
13 ==========
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
14
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
15 If you want to quickly give it a spin:
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
16
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
17 ::
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
18
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
19 pip install piecrust
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
20 chef init mywebsite
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
21 cd mywebsite
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
22 chef serve
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
23
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
24 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
25 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
26 to see the default home page.
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
27
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
28 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
29 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
30
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
31 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
32 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
33 ``_counter`` to your server.
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
34
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
35
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
36 Changes
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
37 =======
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
38
160
de09d41bae23 Moved all installation instructions to a new `INSTALL` file.
Ludovic Chabant <ludovic@chabant.com>
parents: 134
diff changeset
39 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
40 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
41
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
42
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
43 Installation
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
160
de09d41bae23 Moved all installation instructions to a new `INSTALL` file.
Ludovic Chabant <ludovic@chabant.com>
parents: 134
diff changeset
46 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
47
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
48 ::
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
49
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
50 pip install piecrust
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
51
160
de09d41bae23 Moved all installation instructions to a new `INSTALL` file.
Ludovic Chabant <ludovic@chabant.com>
parents: 134
diff changeset
52 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
53 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
54