mirror of
https://github.com/cypress-io/cypress.git
synced 2026-05-03 13:30:26 -05:00
Gleb Bahmutov
420c896b3d
* docs: set full url to staging * docs: test after deploy * add dot missing in deploy regular expression * increase docs start timeout * docs: catch missing css/cypress.css and js/toc.js after deploy * docs: generate single application.js on staging * docs: test for magic variable to detect missing js * docs: test search drop down on intro page * docs: add e2e test to catch missing sidebar * docs: split build * docs: run build file save * docs: ls public before generating build.json * docs: generate docs in debug mode * setup custom linting rules inside themes/cypress/source to keep them ES5 * more eslint wrangling
64 lines
1.5 KiB
Markdown
64 lines
1.5 KiB
Markdown
# Cypress Documentation
|
|
|
|
The code for Cypress' Documentation including Guides, API, Examples, Dashboard & FAQ.
|
|
|
|
* https://docs.cypress.io
|
|
|
|
## Contributing
|
|
|
|
Please see our [Documentation Contributing Guideline](/CONTRIBUTING.md)
|
|
|
|
### Installing Dependencies
|
|
|
|
```shell
|
|
npm install
|
|
|
|
npm run build
|
|
```
|
|
|
|
### Starting the server
|
|
|
|
```shell
|
|
npm start
|
|
```
|
|
|
|
Visit [http://localhost:2222/](http://localhost:2222/)
|
|
|
|
### Writing Docs
|
|
|
|
#### Links
|
|
|
|
Links are all handled through our [cypress.on](https://github.com/cypress-io/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
|
|
|
|
```shell
|
|
npm run deploy
|
|
```
|
|
|
|
Look at scripts in `cy_scripts` folder for deployment steps.
|