## 1. Project Overview & Quickstart (mochajs/mocha)

## File: README.md

## Links

- **[Documentation](https://mochajs.org)**
- **[Release Notes / History / Changes](https://github.com/mochajs/mocha/blob/main/CHANGELOG.md)**
- [Code of Conduct](https://github.com/mochajs/mocha/blob/main/.github/CODE_OF_CONDUCT.md)
- [Contributing](https://github.com/mochajs/mocha/blob/main/.github/CONTRIBUTING.md)
- [Development](https://github.com/mochajs/mocha/blob/main/.github/DEVELOPMENT.md)
- [Discord](https://discord.gg/KeDn2uXhER) (ask questions here!)
- [Issue Tracker](https://github.com/mochajs/mocha/issues)

## Backers

[Become a backer](https://opencollective.com/mochajs) and show your support to our open source project on [our site](https://mochajs.org/#backers).

[](https://opencollective.com/mochajs)

## Sponsors

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](https://github.com/mochajs/mocha#readme) and on [our site](https://mochajs.org#sponsors) - who doesn't want a little extra exposure?
[Here's the info](https://opencollective.com/mochajs).

[](https://opencollective.com/mochajs/tiers/sponsors/0/website)
[](https://opencollective.com/mochajs/tiers/sponsors/1/website)
[](https://opencollective.com/mochajs/tiers/sponsors/2/website)
[](https://opencollective.com/mochajs/tiers/sponsors/3/website)

## Development

You might want to know that:

- Mocha is one of the _most-depended-upon_ modules on npm (source: [libraries.io](https://libraries.io/search?order=desc&platforms=NPM&sort=dependents_count)), 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](https://github.com/mochajs/mocha/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
- Mocha could use a hand with [these issues](https://github.com/mochajs/mocha/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- The [maintainer's handbook](https://github.com/mochajs/mocha/blob/main/MAINTAINERS.md) explains how things get done

Finally, come [chat with the maintainers on Discord](https://discord.gg/KeDn2uXhER) if you want to help with:

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

## License

Copyright 2011-2024 OpenJS Foundation and contributors. Licensed [MIT](https://github.com/mochajs/mocha/blob/main/LICENSE).

---

## File: docs/README.md

# Mocha Docs: Built on Astro Starlight

This is the current Mocha documentation website, hosted at [mochajs.org](https://mochajs.org) and built with [Astro Starlight](https://starlight.astro.build).

> For details on the legacy site, see [https://github.com/mochajs/docs-legacy](mochajs/docs-legacy).

## Preview the new site

To run this site:

```shell
cd docs
npm i
npm run generate
npm run dev
```

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

## File: README.md

# mochajs.org

These are the legacy docs for Mocha built using [Eleventy](https://www.11ty.io/), a simple static site generator.
They used to be served on [mochajs.org](https://mochajs.org); now they're served on [legacy.mochajs.org](https://legacy.mochajs.org).

## Development

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

### Notes

- 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

# 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](https://github.com/mochajs/mocha/blob/main/CHANGELOG.md)._