We currently only have installation instructions for MacOS. If you're using Windows or Linux, ensure that you have Ruby (see .ruby-version in the repo root for the current version)+ Node.js installed before running the commands in the README
- SSH authentication: Generate and add an SSH key to your GitHub account. For more information, see Generating a new SSH key and adding it to the ssh-agent and Adding a new SSH key to your GitHub account in GitHub Docs.
- Personal access token authentication: Create a personal access token for your GitHub account. For more information, see Creating a personal access token in GitHub Docs.
xcode-select --install
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install rbenv ruby-build node
If you are prompted, follow the Next steps instructions to add Homebrew to your PATH.
git config --global user.name "Your Name"
git config --global user.email "user@example.com"
chsh -s /bin/zsh
rbenv init
echo 'eval "$(rbenv init - zsh)"' >> ~/.zshrc
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc
The method you use to clone the repository differs depending on if you use SSH or a personal access token.
If you are using a personal access token, run the following:
git clone https://github.com/Kong/docs.konghq.com.git
cd docs.konghq.com
rbenv install $(cat .ruby-version)
rbenv global $(cat .ruby-version)
gem install bundler
If you are using SSH, run the following:
git clone git@github.com:Kong/docs.konghq.com
cd docs.konghq.com
rbenv install $(cat .ruby-version)
rbenv global $(cat .ruby-version)
gem install bundler
At this point you can go back to the README and continue reading the Run Locally
instructions.
If I get an error while attempting to install dependencies for building the docs site locally, what can I do?
You can try installing next step i.e. gem install liquid-c -v '4.0.0' --source 'https://rubygems.org/' -- --with-cflags=\"-Wno-compound-token-split-by-macro\"
, to install missing dependencies.