The website is hosted using Github Pages and built using Jekyll. The files that make up the website are contained within the
docs folder (as Github Pages requires) within the master branch. You’ll find more details about how they are organized and their purpose below.
. ├── site > Contains MD files that need to go under the base website │ └── **.md ├── kb > Contains MD files for the documentation section of the website │ ├── img │ │ └── **.png > images required for documentation │ └── **.md > All the MDs that make up the documentation ├── assets > Contains JS, CSS, IMGs for the site │ ├── js │ ├── img │ └── css ├── index.html > Website Landing page ├── README.md *** You are here ├── _config.yml > Site wide configuration and variables └── Gemfile > Plugins required for the website to be built by Jekyll
In order for Jekyll to process the MD files and render them as html, you’ll need to add the below to the beginning of the each MD file.
--- layout: resources # choose between default, docs, page or resources title: Additional Resources # provide the title for the web page description: Update this # this shows up in the Website description permalink: /resources # this is the short link for the page, if empty the relative path of the md file is used #other yaml data that can be referenced within the page ---
To ensure the changes to any file or folder that power the website is valid, please setup this step below that allows you to build the website, verify changes locally before you push to the repo.
Install the following for an easy to use dev environment:
brew install rbenv rbenv install 2.6.3 gem install bundler
Note: if you hit a permissions error for the
gem install bundler follow advice from the bundler docs
If you are running a build on Ubuntu you will need the following packages:
If you are on Windows, all hope is not lost. Follow the steps here to install the dependencies - https://jekyllrb.com/docs/installation/windows/
gem install github-pagesThis mirrors the plug-ins used by GitHub Pages on your local machine including Jekyll, Sass, etc.
git clone email@example.com:vmware-samples/vcenter-event-broker-appliance.git cd vcenter-event-broker-appliance/docs bundle install
jekyll serve --livereload --incremental. You may need to run
bundle exec jekyll serve --livereload --incremental.
bundle exec jekyll clean bundle exec jekyll serve --incremental --livereload