mirror of
https://github.com/zap-proto/cpp-core.git
synced 2026-10-30 15:06:00 +00:00
98e98a87d7
* Clarify doc on absolute path imports The current documentation caused confusion with the term "absolute path" in import statements in combination with the search path directories. An example should avoid this confusion. * Update doc/language.md Co-authored-by: Kenton Varda <[email protected]>
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.