appium.io
The public front-end for Appium, visible at appium.io. There are two components to this:
- A Jekyll server which takes markdown files and turns them into our public-facing website
- A set of scripts which take the Appium docs and convert them to HTML using MkDocs
To locally preview appium.io
Requirements
- Ruby 2.1.0 or higher
- Node + NPM
- Ruby Bundler (
gem install bundler
) - pip (
brew install pip
) - MkDocs 0.16.3 (
pip install mkdocs==0.16.3
)
Setup
bundle install
npm install
Development
Build the docs (this clones the Appium repo with its docs folder into a temp
directory, and runs MkDocs on that to generate HTML inside the local docs/
folder)
npm run build:docs
Build the docs locally. Must set env variable LOCAL_APPIUM to the path to your local appium repo
npm run build:docs:local
Start a local Jekyll server (this allows you to view appium.io at localhost:4000
):
npm run serve
Lint & test:
npm run lint
npm run test
Crawl for broken links:
npm run crawl
Publishing
Newly built docs must be committed and pushed to the gh-pages
branch on GitHub.