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 `python -m catsup.app <server/deploy/webhook>`
##Run
```bash
python -m catsup.app 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`python -m catsup.app 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 `python -m catsup.app <server/deploy/webhook>`
##Run
```bash
python -m catsup.app 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`python -m catsup.app 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.3.tar.gz
(8.0 kB
view details)
Built Distribution
catsup-0.0.3-py2.7.egg
(19.0 kB
view details)
File details
Details for the file catsup-0.0.3.tar.gz.
File metadata
- Download URL: catsup-0.0.3.tar.gz
- Upload date:
- Size: 8.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 51a9481c4a36e4ebdfa3b49772dfeb4f5799f8bfb37542fdf4f1aa44a70c359a |
|
| MD5 | 51813796cb4b38f8a21a7d49d65237cc |
|
| BLAKE2b-256 | f4c5e0144ebbfef08e20e0b1c7892f5919145dbceb3b7f08eec09afad44c6818 |
File details
Details for the file catsup-0.0.3-py2.7.egg.
File metadata
- Download URL: catsup-0.0.3-py2.7.egg
- Upload date:
- Size: 19.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9c5ad254691eb31f3bfdd0a8dc72db8427eebd0b1d1e11acc900c9e057ed5b8b |
|
| MD5 | c5a60d814ccbdf9fce5ba8388a82ebb6 |
|
| BLAKE2b-256 | a5099a92de3ca3417a9b4ca17e56e2cb4bfcb3b502b061ea34f321087e12d820 |
