Skip to content

Latest commit

 

History

History
48 lines (27 loc) · 1.79 KB

README.md

File metadata and controls

48 lines (27 loc) · 1.79 KB
Raw

SmallRye.io Website Based on Jekyll

Getting Started

These instructions will get you a copy of the SmallRye.io website up and running on your local machine for development and testing purposes.

Installation

Jekyll static site generator docs.

  1. Install a full Ruby development environment

  2. Install Jekyll and bundler gems

     gem install jekyll bundler

  3. Fork the project repository, then clone your fork.

     git clone [email protected]:YOUR_USER_NAME/smallrye.github.io.git

  4. Change into the project directory:

     cd smallrye.github.io

  5. Use bundler to fetch all required gems in their respective versions

     bundle install

  6. Build the site and make it available on a local server

     bundle exec jekyll serve

  7. 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.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This website is licensed under the Creative Commons Attribution 3.0.