@bahmutov/cypress-examples 

[![ci status][ci image]][ci url] [![prettier status][prettier image]][prettier url] [![deployed status][deployed image]][deployed url] [![renovate-app badge][renovate-badge]][renovate-app] !cypress version

> Static site with Cypress examples tested right from the Markdown sources

Live site glebbahmutov.com/cypress-examples/

Benefits

- single source of truth for tests and HTML pages. No more copy / pasting
- Cypress runs tests using Markdown source files via cypress-markdown-preprocessor and cypress-fiddle
- great development experience with live reload and optimized static build thanks to [Vuepress][vuepress] and Prettier formatting
- JavaScript specs are extracted and published as NPM package @bahmutov/cypress-examples after testing against the deployed site and then published to NPM under @bahmutov/cypress-examples
- excellent text and code comment search thanks to Algolia
- Scrape Static Site with Algolia blog post
- scrape happens after deploying the docs to GitHub Pages in .github/workflows/deployed.yml workflow
- recipes that are not included in the NPM package but deployed to the static pages
- top level pages redirect to the deployed version pages. For example if the user visits /cypress-examples/ they are redirected to /cypress-examples/x.y.z/ page.

Blog posts

The following blog posts explain how I write Cypress demo tests using Markdown in this repository

- Run End-to-end Tests from Markdown Files
- Write Cypress Markdown Preprocessor

You can see the cypress.json and plugins.js to learn how cypress-markdown-preprocessor is set tup.

Notes

- use "function" syntax in