This project keeps all sources used for building up Apache bRPC website which's served at https://brpc.apache.org.
The Apache bRPC Website are built using Hugo with the Docsy theme. This project contains the hugo project, markdown files, and theme configurations.
Install pre-requisites
$ sudo apt install npm
$ npm install
git clone https://github.com/apache/brpc-website.git
cd brpc-website
hugo server
Navigate to http://localhost:1313
If you want to generate the static pages in /public folder, just run
hugo
We choose master branch to hold all the site source change and asf-site for apache github website. Please sent your PR to the master branch instead of asf-site.
The structure of /content folder is as follows in which the files you will mainly modify. Take adding a new committer info to the Community page and adding a new bRPC release version info to Download bRPC page as an example, just find the index.md
documents in their corresponding subfolder of /content then modify them. Or just click the Edit this page/编辑本页 button on their pages and modify them directly. Modifying other files or pages is similar.
brpc-website - content | - en | | - docs | | | - community | | | | - index.md | | | - DownloadBRPC | | | | - index.md | | | - ... | - zh | | - docs | | | - community | | | | - index.md | | | - DownloadBRPC | | | | - index.md | | | - ...
You may encounter the Piped Failed problem when you execute the hugo server
or hugo
command, the solution is as follows.
sudo launchctl limit maxfiles 65535 200000 ulimit -n 65535 sudo sysctl -w kern.maxfiles=100000 sudo sysctl -w kern.maxfilesperproc=65535