Need help with cypress-documentation?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

cypress-io
369 Stars 694 Forks MIT License 4.9K Commits 167 Opened issues

Description

Cypress Documentation including Guides, API, Plugins, Examples, & FAQ.

Services available

!
?

Need anything else?

Contributors list

Cypress Documentation Cypress Dashboard first-timers-only

The code for Cypress Documentation including Guides, API, Examples, Dashboard & FAQ found at https://docs.cypress.io.

Cypress Documentation Preview

CI status

CircleCI

master
branch

Netlify Status

Getting Started

Install the dependencies:

yarn

Run the app:

yarn start

You can view the app by visiting http://localhost:3000/.

Building

You can create a statically generated version of the website by running the following:

yarn build

This will generate a

dist
directory that you can serve up.

Note: If you want to create and view a statically generated version of the documentation site, you can run the following:

yarn run start:ci

You can view the statically generated site at http://localhost:3000/.

Testing

We use Cypress itself to test the documentation.

Run the tests:

yarn test

Contributing

Refer to the

CONTRIBUTING.md
guide for details.

License

This project is licensed under the terms of the MIT license.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.