Files
cypress/docs
Brian Mann 26b47aa94f docs: added doc scraping to deploy process
- explain how to add circle ci credentials
- spin up circle instance to scrape the docs
- messaging + error handling
2017-06-17 13:50:14 -04:00
..
2017-06-12 17:25:51 -04:00
2017-06-16 17:33:22 -04:00
2017-06-16 15:42:30 -04:00
2017-06-11 18:26:31 -04:00

Cypress Documentation

The code for Cypress's Documentation, Guides, and API.

Introduction

The documents in this repo are generated using Hexo.

Contributing

Installing Dependencies

npm install

Starting the server

npm start

Visit http://localhost:2222/

Writing Docs

Links are all handled through our cypress.on api.

To link to a page on Guides:

[Installing and Running](https://on.cypress.io/guides/$slug)

To link to a page on API:

[and](https://on.cypress.io/api/$slug)

Creating New Files

When creating new files, each file requires a title followed by ---:

title: Making Assertions
<!-- Set comments to true to add Disqus -->
comments: true   
---

Deploying

npm run deploy