mocha Documentation

1. Project Overview & Quickstart (mochajs/mocha) Copy Chapter

File: README.md Copy Chapter

Links Copy Chapter

• Documentation
• Release Notes / History / Changes
• Code of Conduct
• Contributing
• Development
• Discord (ask questions here!)
• Issue Tracker

Backers Copy Chapter

Become a backer and show your support to our open source project on our site.

Sponsors Copy Chapter

Does your company use Mocha? Ask your manager or marketing team if your company would be interested in supporting our project.
Support will allow the maintainers to dedicate more time for maintenance and new features for everyone.
Also, your company's logo will show on GitHub and on our site - who doesn't want a little extra exposure?
Here's the info.

Development Copy Chapter

You might want to know that:

• Mocha is one of the most-depended-upon modules on npm (source: libraries.io), and
• Mocha is an independent open-source project, maintained exclusively by volunteers.

You might want to help:

• New to contributing to Mocha? Check out this list of good first issues
• Mocha could use a hand with these issues
• The maintainer's handbook explains how things get done

Finally, come chat with the maintainers on Discord if you want to help with:

• Triaging issues, answering questions
• Review, merging, and closing pull requests
• Other project-maintenance-y things

License Copy Chapter

Copyright 2011-2024 OpenJS Foundation and contributors. Licensed MIT.

File: docs/README.md Copy Chapter

Mocha Docs: Built on Astro Starlight

This is the current Mocha documentation website, hosted at mochajs.org and built with Astro Starlight.

For details on the legacy site, see https://github.com/mochajs/docs-legacy.

Preview the new site Copy Chapter

To run this site:

cd docs
npm i
npm run generate
npm run dev

2. Official Technical Reference & Guides (mochajs/docs-legacy) Copy Chapter

File: README.md Copy Chapter

mochajs.org

These are the legacy docs for Mocha built using Eleventy, a simple static site generator.
They used to be served on mochajs.org; now they're served on legacy.mochajs.org.

Development Copy Chapter

1. Run npm install from working copy root to get Node.js deps.
2. To include the API documentation, run npm run api before the either of the following commands.
3. To serve the site and rebuild as changes are made, run npm run watch.
4. To rebuild the site once, run npm run docs.
5. To preview the site, run npm run preview.

Notes Copy Section

• The content lives in index.md; everything else is markup, scripts, assets, etc.
• This file (README.md) should not be included in the build.
• _site_ is where the deployed site lives. This directory is not under version control.

File: changelogs/README.md Copy Chapter

Historical Changelogs

These are changelogs for (very) old versions of Mocha.

These changelogs are not included in the website, and are here only for archival purposes.

If you're looking for the current changelog, here is the current changelog.