https://github.com/appium/appium.io
[deprecated] The public front-end for Appium
https://github.com/appium/appium.io
Last synced: 9 months ago
JSON representation
[deprecated] The public front-end for Appium
- Host: GitHub
- URL: https://github.com/appium/appium.io
- Owner: appium
- Created: 2013-04-05T20:51:20.000Z (over 13 years ago)
- Default Branch: gh-pages
- Last Pushed: 2023-05-04T06:33:51.000Z (about 3 years ago)
- Last Synced: 2025-04-19T10:56:25.840Z (about 1 year ago)
- Language: CSS
- Homepage: https://appium.github.io/appium.io/docs/en/about-appium/intro/
- Size: 31.6 MB
- Stars: 21
- Watchers: 28
- Forks: 45
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: history.md
- Contributing: contributing.md
Awesome Lists containing this project
README
This repository is for deprecated appium.io WebSite.
https://appium.github.io/appium.io/docs/en/about-appium/intro/
appium.io
=========
The public front-end for Appium, visible at [appium.io](http://appium.io).
There are two components to this:
1. A Jekyll server which takes markdown files and turns them into our public-facing website
2. A set of scripts which take the Appium docs and convert them to HTML using MkDocs
To locally preview appium.io
## Requirements
1. [Ruby 2.1.0 or higher](https://www.ruby-lang.org/en/downloads/)
- macOS system installed Ruby might cause installation issue
1. Node + NPM
1. Ruby Bundler (`gem install bundler`)
1. pip (`brew install pip`)
1. MkDocs 0.17.5 (`pip install mkdocs==0.17.5`)
## Setup
```
bundle install
npm install
```
## Development
```
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.