mirror of
https://github.com/cypress-io/cypress.git
synced 2026-03-01 20:39:30 -06:00
0fc4dab3c7
* docs: run hexo server and cypress e2e tests in parallel * docs: enable e2e docs tests on CircleCI * pass record key via env CYPRESS_DOCS_RECORD_KEY to cypress run command * docs: renaming e2e task names * ts: cache node_modules folder * docs: unit test helpful message * typo in script name * cache .cypress folder * do not ignore fixtures folder
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:4000/
Writing Docs
Links
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