ramirezalex / cypress-documentation

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

Cypress Documentation

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

CI status

• develop branch
• master branch

Getting Started

You should be able to get the documentation site running locally very quickly, please see our Contributing Guideline.

Cypress is first time OSS contributor friendly. See these issues to contribute in a meaningful way.

Contentful driven data:

If you need any Contentful driven data to be parsed before Hexo serve - you need to declare it Circle CI or/and bash. You may need Contentful environment variables inside your machine or container:

• GATSBY_CONTENTFUL_SPACE_ID

  Contentful 12 digit key. You can find it (if you have granted access) in Contentful acc:

  Settings → API keys → Master → Space ID

• GATSBY_CONTENTFUL_ACCESS_TOKEN

  Contentful 64 digit token. You can find it (if you have granted access) in Contentful acc:

  Settings → API keys → Master → Content Delivery API - access token

P.S. If you don't have any of this - Hexo will build & serve as usual, but without any Contentful driven data.

Deploying

See our Deploy Guideline.

License

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