Giter Site home page Giter Site logo

catsup's Introduction

catsup

image

A lightweight static blog generator. Document here: https://catsup.readthedocs.org/en/latest/

Install

Simple way using pip:

pip install catsup

Or another hard way to install:

git clone git://github.com/whtsky/catsup.git
cd catsup

# We use git submodules to organize out theme.
# If you don't want the default theme(current version is sealscript)
# You can skip these command.
git submodule init
git submodule update

python setup.py install

Setup your blog

Change directory to the directory you prefer to place your blog and run catsup init to initialize it.

Then you can edit config.json to change your configuration.

Write a post

Catsup support markup of Markdown. Filename should like year-month-day-title.md

(For example: 2000-01-01-catsup.md)

Post Example:

#Title

----

Content
```python
print "hi,I'm coding."
```

Install theme

Run catsup themes to list available themes. And run catsup install path [-g] to install a new theme.

If -g flag present, the theme would be install in the global themes directory.

path could be a url of a git repo or path to the theme folder.

If it's a git repo, catsup will clone and install it automatically.

Build your blog

run catsup build And you can find your static blog in ~/build/ .

catsup's People

Contributors

whtsky avatar messense avatar jmpotato avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.