README.md 677 Bytes
Newer Older
Kenton Varda's avatar
Kenton Varda committed
1
# Cap'n Proto Documentation
2

Kenton Varda's avatar
Kenton Varda committed
3
This directory contains the "source code" for the Cap'n Proto web site.
4

Kenton Varda's avatar
Kenton Varda committed
5
The site is built with [Jekyll](http://jekyllrb.com/).  Start by installing it.
6 7 8 9 10

Be sure to follow the instructions to install Pygments as well.

Next, install the custom Pygments syntax highlighter:

Kenton Varda's avatar
Kenton Varda committed
11 12 13
    cd _plugins
    python capnp_lexer.py install
    cd ..
14 15 16

Now you can launch a local server:

Kenton Varda's avatar
Kenton Varda committed
17
    jekyll --server --auto --pygments
18 19 20

Edit, test, commit.

Kenton Varda's avatar
Kenton Varda committed
21
If you have permission, after you've pushed your changes back to github, you can make your changes live by running:
22

Kenton Varda's avatar
Kenton Varda committed
23
    ./push-site.sh
24

Kenton Varda's avatar
Kenton Varda committed
25
Otherwise, send a pull request and let someone else actually push the new site.