Cypress Documentation
The code for Cypress' Documentation including Guides, API, Examples, Dashboard & FAQ.
Contributing
Please see our Documentation Contributing Guideline
Installing Dependencies
npm install
npm run build
Starting the server
npm start
Visit http://localhost:2222/
Writing Docs
Links
Links are all handled through our cypress.on api.
Link all pages but their name (property key) in source/_data/sidebar.yml
- https://on.cypress.io/NAME_OF_PAGE
- https://on.cypress.io/and
- https://on.cypress.io/visit
- https://on.cypress.io/unit-testing-recipe
- https://on.cypress.io/introduction-to-cypress
- https://on.cypress.io/writing-your-first-test
- https://on.cypress.io/general-questions-faq
Linting
Danger 📛: because we are minifying client side code using Hexo plugin which in turn calls
uglify, the code should be strictly ES5. Thus everything inside the theme should
be linted with ES5 settings and not upgraded to ES6.
Deploying
Preferred: deploy from CI
Look at circle.yml file in the root of the repo. It should have
deploy-docs-staging and deploy-docs-production jobs, which only are triggered for right
branch and only after tests pass.
Should not be required: manual deploy
npm run deploy
Look at scripts in cy_scripts folder for deployment steps.