Cypress Documentation

CI status

main branch

Our docs are built using Docusaurus.

Installation

$ npm i

Local Development

$ npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the dist directory and can be served using any static contents hosting service.

LLM Docs

The build process reprocesses the content into both markdown and chunked JSON to be published under /llm - these formats strip out unnecessary styling and formatting which can be difficult and/or token-inefficient for use by LLMs. Three files at the site root index them:

• /llms.txt - a link index of every documentation page, in the llmstxt.org format.
• /llms-full.txt - the whole corpus concatenated into one markdown file.
• /docs-manifest.json - project metadata and the machine-readable list of every format published.

Contributing

Refer to the CONTRIBUTING.md guide for details.

License

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