# catsup

**Repository Path**: mirrors/catsup

## Basic Information

- **Project Name**: catsup
- **Description**: No description available
- **Primary Language**: HTML/CSS
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/catsup
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-04-02
- **Last Updated**: 2025-12-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Catsup
----------------

.. image:: https://travis-ci.org/whtsky/Catsup.png?branch=develop
        :target: https://travis-ci.org/whtsky/Catsup

.. image:: https://coveralls.io/repos/whtsky/catsup/badge.png?branch=develop
        :target: https://coveralls.io/r/whtsky/catsup?branch=develop


Catsup is a lightweight static website generator which aims to be simple and elegant.
Documentation is available at RTFD: https://catsup.readthedocs.org/en/latest/

Quick Start
===============

First, install Catsup via pip ::

    $ pip install catsup

Then, create a new Catsup site ::

    $ mkdir site
    $ cd site
    $ catsup init

Edit the config file ::

    vim config.json

Write some posts ::

    $ vim posts/hello-world.md
    $ cat posts/hello-world.md
    # Hello World

    - tags: hello world, catsup
    - time: 2013-08-30 12:00

    ---

    Hello, World!

Build your site and deploy ::

    catsup build && catsup deploy

For more information, please read the document: https://catsup.readthedocs.org/en/latest/