Catsup: a lightweight static blog generator
Project description
#catsup
##License
Licensed under the MIT License.
##Install
Simple way using pip
```bash
pip install catsup
```
Or another hard way to install
```bash
git clone git://github.com/whtsky/catsup.git
cd catsup
python setup.py install
```
##Settings
The default settings file is at `~/.catsuprc`, you can specific it by passing `--settings=/path/to/settings` when executing `catsup <server/deploy/webhook>`
For simple usage, just copy and rename config.py to ~/.catsuprc and modify it as you like.
##Run
```bash
catsup server --port=8888
```
Then go to http://localhost:8888 to take a look at your own catsup.:-)
##How to write
catsup uses Markdown to write posts.
Filename should like 2000-01-01-catsup.md(year-month-day-title.md)
Example:
#Title
- tags: tag1, tag2, tag3
----
Content
```python
print "hi,I'm coding."
```
### Post properties
catsup supports some post properties. Write them before "---" and start with "- ".
Example:
- category: A Category
- date: 2012-12-24
- tags: tag1, tag2
- comment: no
The `category` property defines the category of the post, but it's not used yet.
The `date` property can overwrite the date from the file name.
The `tags` property defines the tags of the post.
The `comment` property defines whether the post can be commented or not.
### Post excerpt
You can use `<!--more-->` to define an excerpt of a post. Any content before that will be used as excerpt of the post. And you can choose to display excerpt rather than full content on your homepage.
##Deploy a static blog
run`catsup deploy`
And you can find your static blog in deploy/ .
##License
Licensed under the MIT License.
##Install
Simple way using pip
```bash
pip install catsup
```
Or another hard way to install
```bash
git clone git://github.com/whtsky/catsup.git
cd catsup
python setup.py install
```
##Settings
The default settings file is at `~/.catsuprc`, you can specific it by passing `--settings=/path/to/settings` when executing `catsup <server/deploy/webhook>`
For simple usage, just copy and rename config.py to ~/.catsuprc and modify it as you like.
##Run
```bash
catsup server --port=8888
```
Then go to http://localhost:8888 to take a look at your own catsup.:-)
##How to write
catsup uses Markdown to write posts.
Filename should like 2000-01-01-catsup.md(year-month-day-title.md)
Example:
#Title
- tags: tag1, tag2, tag3
----
Content
```python
print "hi,I'm coding."
```
### Post properties
catsup supports some post properties. Write them before "---" and start with "- ".
Example:
- category: A Category
- date: 2012-12-24
- tags: tag1, tag2
- comment: no
The `category` property defines the category of the post, but it's not used yet.
The `date` property can overwrite the date from the file name.
The `tags` property defines the tags of the post.
The `comment` property defines whether the post can be commented or not.
### Post excerpt
You can use `<!--more-->` to define an excerpt of a post. Any content before that will be used as excerpt of the post. And you can choose to display excerpt rather than full content on your homepage.
##Deploy a static blog
run`catsup deploy`
And you can find your static blog in deploy/ .
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
catsup-0.0.5.tar.gz
(39.8 kB
view hashes)
Built Distribution
catsup-0.0.5-py2.7.egg
(56.6 kB
view hashes)
