Note
The content of this master
branch is old, 👉 checkout Hyperfoil repository for the website source code or the gh-pages branch of this repository for the live content published at hyperfoil.io.
Starting from July 15th, we published a renewed version of the Hyperfoil website.
With this renewal we changed some things that are summarized below:
- The source code of the website has been move in the Hyperfoil repository, this way docs changes can be done in the same pull request of the feature change.
- The website is entirely based on docsy Hugo template, therefore we switched to Hugo as static site generator.
- The live content is hosted in the gh-pages branch of this repository, we will empty the
master
one in the coming future. - The website deployment is automated using a GitHub worklofow, see deploy-gh-pages.yaml for more details.
- The live content points to the latest stable branch in the Hyperfoil repository, e.g.,
0.26.x
. You can find the used branch in the deploy-gh-pages.yaml configuration.
For more information on how to build (locally) and update the website content, please checkout github.com/Hyperfoil/Hyperfoil/docs.
Note
This content will be removed in the coming future!
The master
branch contains the content for the old Jekyll-based static website that is no longer published anywhere.
These instructions will get you a copy of the Hyperfoil.io website up and running on your local machine for development and testing purposes.
Jekyll static site generator docs.
-
Install a full Ruby development environment
-
gem install bundler
-
Fork the project repository, then clone your fork.
git clone git@github.com:YOUR_USER_NAME/hyperfoil.github.io.git
-
Change into the project directory:
cd hyperfoil.github.io
-
Use bundler to fetch all required gems in their respective versions
bundle install
-
Build the site and make it available on a local server
bundle exec jekyll serve
-
Now browse to http://localhost:4000
If you encounter any unexpected errors during the above, please refer to the troubleshooting page or the requirements page, as you might be missing development headers or other prerequisites.
For more regarding the use of Jekyll, please refer to the Jekyll Step by Step Tutorial.
This website is licensed under the Creative Commons Attribution 3.0.