kevinlambert / webdriver.io

Official website of the WebdriverIO project

webdriver.io

Official website of the WebdriverIO project

Requirements

To deploy the website to the server, you will need the following dependencies installed on the machine

• NodeJS
• SASS (gem install sass)
• Compass (gem install compass)
• Hexo v3.1 (npm install hexo-cli -g)
• YUI compressor (brew install yuicompressor) - only required for deployment

Setup

First download the repository:

$ git clone [email protected]:webdriverio/webdriver.io.git

Next install dependencies:

$ npm install -g hexo-cli
$ npm install

Now grab the documentation content from the main repository

$ hexo wdio getDocs

and generate the assets using Compass

$ hexo wdio compass

That's it. You can now run the server with:

$ hexo server

Deployment

To generate the markdown pages and static files run the following command:

$ npm run build
$ hexo deploy

It installs all dependencies, generates the markdown files from the current WebdriverIO version on NPM, renders all templates to static html files and generates and minifies assets. All necessary files should be located in a single directory called public. Last but not least let the domain point to this directory. That's it.

Trouble Shooting

When I start the server I get a 404 page Cannot GET /

Make sure you have the documentation content copied into the source directory. We keep all documentation within the main repository (github.com/webdriverio/webdriverio). Just run hexo wdio getDocs and restart the server.