PK 'SFD catsup-v0.3.3/searchindex.jsSearch.setIndex({envversion:42,terms:{all:[4,5,3],code:[1,6,2],skip:6,month:8,follow:3,articl:5,init:[4,6],program:[7,2],sourc:[5,1,8,2],everi:[5,3,7],string:5,fals:8,util:[5,1],syntax:0,list:5,ssh_host:[4,8],pleas:4,enjoi:4,cost:1,design:5,pass:3,click:2,index:[5,8,7],what:[4,7],sub:1,section:[4,3],current:[5,7,6],delet:[4,8],post_per_pag:5,"new":[0,2],full:1,hash:1,gener:[0,1,2,4,5,7],here:[4,8,2],bodi:5,let:4,ubuntu:6,path:[5,1,2],strong:[4,7],modifi:2,sinc:3,datetim:8,chang:[8,4,1,3,2],via:[4,1,6,2],love:[4,7],forbid:7,prefer:8,submodul:6,apt:6,vim:4,put:7,href:5,instal:[0,1],txt:[7,1],highli:4,feb:1,upgrad:0,websit:[0,8],few:4,stylesheet:5,call:4,xmldatetim:5,type:[4,5,8,7,2],more:[4,8],canon:5,hurri:4,deploy_to_which_path:4,cach:[3,1],render_com:5,sometim:7,setup:6,dev:6,itself:3,can:[2,3,4,5,6,7,8],learn:[4,5],ip_address_of_your_serv:4,process:2,sudo:6,templat:0,tag:[4,5,8,7,1],want:[3,4,5,6,7,8],exmapl:8,alwai:[7,6],mai:[7,8,6,2],anoth:8,ordinari:7,write:[0,7,1,2],how:[5,3],pagin:[5,1],config:1,css:5,updat:[3,6,2],regener:[1,2],clone:[6,2],after:4,befor:[4,1],okai:7,date:8,end:8,permalink:1,github:[7,8,6,2],favorit:4,inform:[7,8],allow:8,talk:4,help:2,over:[4,3],comma:7,gitignor:3,paramet:3,perfect:4,style:[5,8,7],thank:4,fix:1,bytecod:1,yaml:[7,1],easier:5,non:1,"return":5,vaild:8,python:0,jinja2:[5,1],now:[4,1],name:[4,5,8],anyth:3,edit:4,static_sourc:[8,1],drop:1,separ:0,easili:8,pygment:5,compil:6,replac:[4,1],continu:4,meta:[0,8,1],"static":[0,5,8,1],year:8,our:4,happen:4,out:6,variabl:[0,4],user_name_her:4,rewrit:1,rel:5,print:[4,7],correct:1,static_output:[8,1],navig:7,given:5,base:1,releas:[0,1],card:1,md5:1,static_url:1,filter:[0,1],turn:[7,2],place:4,nicknam:[4,8],first:[4,7,8],feed:[5,8],softwar:3,render:[5,1],onc:3,yourself:8,hook:2,open:4,differ:7,mkdir:4,system:[8,3,1],least:7,master:[4,8],too:[4,7],store:3,disqu:[8,1],option:7,tool:6,copi:1,specifi:5,part:7,rss:5,kind:[7,3],eleg:0,structur:0,project:2,browser:4,ani:[8,3,1],have:[4,7,8,3,6],need:[4,5,2],engin:[5,6,1],built:0,note:[7,8],also:[4,5,6],exampl:[4,5,8,2],build:[0,1,2],which:0,sure:[4,3,6],usernam:[4,8],object:5,most:3,deploi:1,homepag:5,model:1,renam:1,url:[4,5,1,8,2],clean:[5,1],shortnam:[8,1],awesom:8,newer:0,text:0,blognam:8,find:0,xml:[5,8],access:5,onli:[4,5],pretti:4,enough:8,should:[5,7],theme:1,folder:[4,1,3,2],analyt:[5,8,1],local:1,get:[0,6],static_prefix:8,familiar:6,simplest:7,watch:1,repo:[4,8,2],requir:[3,6],organ:[3,6],your_github_usernam:4,lyric:5,where:3,summari:1,set:[7,8,2],creator:1,see:4,simpl:[0,4],someth:7,enumer:3,written:7,ssh_user:[4,8],between:7,whouz:4,"import":5,experi:3,email:8,altern:5,my_sit:8,extens:7,job:5,admin:2,howev:3,instanc:5,improv:1,com:[4,5,8,6],comment:1,markdown:[0,6,1],three:7,empti:4,json:[4,8,1],multi:1,look:[4,5,8,7],servic:2,aim:0,defin:[5,8,1],"while":3,everyon:4,cann:0,demo:5,readm:5,site:1,archiv:[5,8,7,1],lightweight:0,suggest:6,make:[4,5,3,7,6],html:[0,8,1],document:[8,3],document_root:[4,8],http:[4,5,8,2],painless:3,temporari:2,older:0,without:[7,2],command:[3,6,1],thi:[4,7,8,3],everyth:[4,7,6],latest:6,load:1,just:[7,8],web:4,easi:[8,6],blog:8,add:[1,3,2],take:4,applic:5,marco:0,rememb:[7,8],format:[7,1],read:[4,5,8],know:4,world:[4,7],daemon:2,like:[2,3,4,5,7,8],filenam:8,server:1,either:7,output:8,page:[0,1,8,2],sitemap:1,right:4,twitter:[8,1],excerpt:1,sampl:[4,7],virtualenv:6,rsync:[4,1,8,2],ujson:1,per:1,sealscript:[5,8,6],run:[4,1,6,2],power:5,host:[4,2],commment:5,from:0,post:[0,1,8,2],about:[4,7,8],mean:2,disabl:[7,8],own:8,ssh_port:[4,8],easy_instal:3,two:8,your:[0,1,2,6,7,8],git:[0,1,8,2],wai:2,support:[8,1],pygments_styl:5,custom:[4,5,1],avail:[5,2],start:[0,7,2],"var":[5,8],"function":0,head:[4,5],reorgan:1,catsup:[1,8,2],theme_nam:5,some:[8,5,3,7],link:[5,8,7],duoshuo:[8,1],don:[4,8,3,6,1],line:[7,3,6],"true":[4,8],bug:1,pull:2,url_for:1,consist:[5,7],"default":[4,1,8,6,2],displai:[7,1],below:7,misaka:6,supervisor:2,creat:0,parser:1,strongli:6,file:[0,8,4,1],pip:0,googl:8,titl:8,when:[7,1,2],branch:[4,8],tempdir:1,you:[2,3,4,5,6,7,8],nice:3,whtsky:[4,5,8,6],consid:7,fresh:4,bitbucket:2,longer:7,directori:2,descript:[4,7,8,1],profit:3,ignor:[3,2],time:[4,7,3,1],push:2,escap:1,hello:[4,7]},objtypes:{},objnames:{},filenames:["index","changelog","goodies","upgrading","start","theme","install","post","config"],titles:["Welcome to Catsup","Changelog","Goodies","Upgrading to Newer Releases","Get Started","Theme","Installation","Post Syntax","Configuration"],objects:{},titleterms:{comment:8,markdown:7,creat:4,cann:6,overview:[5,8,7],global:5,site:[4,8],templat:5,syntax:7,code:7,structur:5,file:5,pip:6,instal:6,guid:0,find:6,variabl:5,content:7,git:6,from:6,welcom:0,author:8,goodi:2,titl:7,support:2,configur:[4,8],upgrad:[3,6],your:4,write:4,start:4,theme:[5,8],version:[3,6,1],build:4,text:7,"new":4,preview:2,config:8,"function":5,marco:5,catsup:0,get:4,python:6,webhook:2,user:0,newer:3,deploi:[4,8,2],releas:3,post:[4,7],built:5,permalink:8,github:4,url_for:5,changelog:1,older:6,html:7,static_url:5,server:[4,2],filter:5,meta:[5,7],own:4,highlight:7,separ:7,page:[4,7]}})PK 'SFD X3o o catsup-v0.3.3/search.html
Please activate JavaScript to enable the search functionality.
From here you can search these documents. Enter your search words into the box below and click "search". Note that the search function will automatically search for all of the words. Pages containing fewer words won't appear in the result list.
Preview your site without deploy
catsup server
catsup server -p 8000
Preview server will regenerate your site when :
Note
Catsup will ignore site.url and build your site into a temporary directory when running Preview Server.
Help you deploy your site via git or rsync
catsup deploy # Deploy via default way
catsup rsync # Deploy via rsync
catsup git # Deploy via git
If you host your site’s source on GitHub or Bitbucket, Catsup can generate your site when you push to your repo.
You need to clone your repo and start webhook server
git clone git://path/to/your/site.git
cd site
catsup webhook -p 12580
Attention
Catsup webhook is not a daemon process.That means you may need to use Supervisor to turn it into daemon.
Then configure webhook on GitHub or Bitbucket. Here we use GitHub as an example:
[1] | If your server’s ip is 1.2.3.4 , you can type http://1.2.3.4:12580/webhook |
Then when you push to GitHub, Catsup will pull and generate your site.
This section needs you have Catsup installed.If you don’t, please go and Install it
It’s pretty simple to create a site using Catsup
$ mkdir site
$ cd site
$ catsup init
Let’s see what happened
$ ls
config.json posts
After running catsup init, Catsup generates a sample config file config.json and an empty post folder posts.
Now, let’s configure your new site.
Catsup can be highly customized, but you only need to change a few variables to get started :
Want to learn more about configuration file? Take a look at Configuration
After configuring your site, it’s time to start writing.
Let’s write a post first
vim posts/hello-world.md
a Hello World post looks like
# Hello, World!
- time: 2013-08-25 23:30
- tags: hello world
---
Hello, World!
This is my first post in catsup.
I'm writing in **MarkDown** !
<strong>HTML is supported, too</strong>
```python
print("I love python")
```
Then, let’s write a page to talk about your site
vim posts/about.md
a About page looks like
# About the site
- time: 2013-08-25 23:31
- type: page
----
Hi!
This site is generated by [catsup](https://github.com/whtsky/catsup).
Read about Post Syntax to learn more.
After writing posts and pages, It’s time to build your site and let everyone know!
But don’t hurry, let’s take a look at your site first
catsup server
Then open your favorite web browser, go to http://127.0.0.1:8888 .
Head over to Preview Server to know more.
After making sure everything’s all right, let’s build the site
catsup build
Let’s see what happened
$ ls
config.json deploy posts
Thanks to GitHub, we have a perfect place to host our site.
You need to have a repo called YOUR_GITHUB_USERNAME.github.io. If you don’t, go to create one
Then edit your configuration file, change deploy section like this
"deploy": {
"default": "git",
"git": {
"repo": "git@github.com:YOUR_GITHUB_USERNAME/YOUR_GITHUB_USERNAME.github.io.git",
"branch": "master",
"delete": true
}
},
replace YOUR_GITHUB_USERNAME with your github username, like whtsky .
After that, let’s deploy your site to GitHub Pages
catsup build && catsup deploy
Then open http://YOUR_GITHUB_USERNAME.github.io to enjoy your fresh site.
Catsup also supports deploy via rsync. Before continue, make sure you have rsync running on your server.
Then edit your configuration file, change deploy section like this
"deploy": {
"default": "rsync",
"rsync": {
"ssh_port": 22,
"ssh_user": "USER_NAME_HERE",
"ssh_host": "IP_ADDRESS_OF_YOUR_SERVER",
"document_root": "DEPLOY_TO_WHICH_PATH",
}
},
Here’s an example
"deploy": {
"default": "rsync",
"rsync": {
"ssh_port": 22,
"ssh_user": "whtsky",
"ssh_host": "whouz.com",
"document_root": "~/whouz.com",
}
},
After that, let’s deploy your site via rsync
catsup build && catsup deploy
Head over to Deploy Support to know more.
Catsup itself is changing like any software is changing over time. Most of the changes are the nice kind, the kind where you don’t have to change anything in your site to profit from a new release.
However every once in a while there are changes that do require some changes in your site.
This section of the documentation enumerates all the changes in Catsup from release to release and how you can change your site to have a painless updating experience.
If you want to use the easy_install command to upgrade your Catsup installation, make sure to pass it the -U parameter:
$ easy_install -U catsup
Catsup adds an cache system since 0.2.0 .
Cache files are stored in .catsup-cache folder, so if you are using git to organize your site and want to ignore the cache files, add the following line to your .gitignore file
.catsup-cache