README.md 946 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

5 6
The site is built with [Jekyll](http://jekyllrb.com/), which depends on Ruby. 
Start by installing ruby1.9.1-dev. On Debian-based operating systems:
7

8
    sudo apt-get install ruby-dev
9 10 11

Then install Jekyll:

12
    sudo gem install jekyll pygments.rb
13 14 15 16 17

Now install Pygments and SetupTools to be able to install the CapnProto lexer.
On Debian based operating systems:

    sudo apt-get install python-pygments python-setuptools
18 19 20

Next, install the custom Pygments syntax highlighter:

Kenton Varda's avatar
Kenton Varda committed
21
    cd _plugins
22
    sudo python capnp_lexer.py install
Kenton Varda's avatar
Kenton Varda committed
23
    cd ..
24 25 26

Now you can launch a local server:

27
    jekyll serve --watch
28 29 30

Edit, test, commit.

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

Kenton Varda's avatar
Kenton Varda committed
33
    ./push-site.sh
34

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