forked from mirror/capnproto
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
7cf7511ee3
|
4 years ago | |
|---|---|---|
| .. | ||
| _includes | 8 years ago | |
| _layouts | 8 years ago | |
| _plugins | 9 years ago | |
| _posts | 4 years ago | |
| go/capnp | 5 years ago | |
| images | 11 years ago | |
| javascripts | 9 years ago | |
| news | 9 years ago | |
| slides-2017.05.18 | 9 years ago | |
| stylesheets | 9 years ago | |
| README.md | 5 years ago | |
| _config.yml | 10 years ago | |
| _config_next.yml | 9 years ago | |
| capnp-tool.md | 6 years ago | |
| cxx.md | 11 years ago | |
| cxxrpc.md | 5 years ago | |
| encoding.md | 5 years ago | |
| faq.md | 11 years ago | |
| feed.xml | 4 years ago | |
| index.md | 5 years ago | |
| install.md | 4 years ago | |
| language.md | 6 years ago | |
| otherlang.md | 6 years ago | |
| push-site.sh | 5 years ago | |
| roadmap.md | 4 years ago | |
| rpc.md | 6 years ago | |
README.md
Cap'n Proto Documentation
This directory contains the "source code" for the Cap'n Proto web site.
The site is built with Jekyll, which depends on Ruby. Start by installing ruby1.9.1-dev. On Debian-based operating systems:
sudo apt-get install ruby-dev
Then install Jekyll 3.8.1 (Jekyll 4.x will NOT work due as they removed Pygments support):
sudo gem install jekyll -v 3.8.1
sudo gem install pygments.rb
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
Next, install the custom Pygments syntax highlighter:
cd _plugins
sudo python capnp_lexer.py install
cd ..
Now you can launch a local server:
jekyll _3.8.1_ serve --watch
Edit, test, commit.
If you have permission, after you've pushed your changes back to github, you can make your changes live by running:
./push-site.sh
Otherwise, send a pull request and let someone else actually push the new site.