testiumjs Website

Local Setup

On MacOS >= High Sierra, it is recommended that you use a ruby version manager like rbenv (you will not have write permissions to the gem installation folder for system ruby):

$ brew install rbenv

Ensure you add the following line to your .bashrc or .zshrc file:

eval "$(rbenv init -)"

The following gives you the ability to use rbenv installed version 2.6.3 of ruby in your shell by typing:

$ rbenv install 2.6.3
$ rbenv shell 2.6.3

Install the bundler gem:

$ gem install bundler

Run the following to install jekyll:

bundle install

Then start the development server via:

bundle exec jekyll server

To update the deployed website, just create a pull request against the master branch.

Creating Pages

Files can be created as Markdown or HTML documents. More information on authoring content can be found in the official Jekyll docs.

Most pages should use the sidebar layout.

Adding Pages to the Sidebar

The structure of the sidebar is configured via _data/sidenav.yml. Example:

  # This creates a top level heading that has no URL or content
- title: Section A
  items:
    # Each item in here appears under "Section A" and will be automatically
    # highlighted when the url matches the current page
  - url: /api.html
    title: API
    # You can also specify an `externalUrl`
  - externalUrl: 'https://example.com/some-url'
    title: Something External
- title: Section B
  items:
  - url: /generic-overview.html
    title: Overview of one aspect of B
    subitems:
    - url: /details.html
      title: More Specific Details
      # All urls are relativ to the project root, so the content for this page
      # would be generated in `nested/file.md`
    - url: /nested/file.html
      title: Even More Details