This project contains the public site for https://xunit.net/.
To open an issue for this project, please visit the core xUnit.net project issue tracker.
This site is built with DocFX. We use a C#-based build system.
In order to successfully build and view the content locally, you will need the following pre-requisites:
If you wish to use ./build serve for live regeneration during development, you will also need:
- NodeJS 22 or later (for the live rebuild monitoring)
- Docker (to host nginx)
The site content lives in /site and the output will placed in /.site. To build the static content, run the command ./build from the root of your clone, via your command prompt (bash and PowerShell are supported). This will do a one-time transformation of the templates in /site to the static files in /.site.
For working interactively, you can run ./build serve which will use NodeJS to run in a mode where it simultaneously builds the site and uses a Docker-based nginx server to serve the static content. It will automatically rebuild the site as you change the site's content files. You can point your browser to http://127.0.0.1:4000/ while the server is running to view the rendered content. Once you're finished, you can press Ctrl+C in the command prompt and the server will shut down. (You may need to press Ctrl+C more than once on Windows.)
Text editors/IDEs which understand site hierarchy and linking while editing Markdown and HTML are strongly encouraged to open the /site folder and not the root folder when editing content, so that the editor understands where the content root lives. For example, if you're using VSCode, you should run code site and not code . from the root of the repo. You should only ever need to open the root of the repo in your editor if you're working on the build tools.
xUnit.net is a free, open source, community-focused unit testing tool for C#, F#, and Visual Basic.
xUnit.net works with the .NET SDK command line tools, Visual Studio, Visual Studio Code, JetBrains Rider, NCrunch, and any development environment compatible with Microsoft Testing Platform (xUnit.net v3) or VSTest (all versions of xUnit.net).
xUnit.net is part of the .NET Foundation and operates under their code of conduct. It is licensed under Apache 2 (an OSI approved license). The project is governed by a Project Lead.
For project documentation, please visit the xUnit.net project home.
- New to xUnit.net? Get started with the .NET SDK.
- Need some help building the source? See BUILDING.md.
- Want to contribute to the project? See CONTRIBUTING.md.
- Want to contribute to the assertion library? See the suggested contribution workflow in the assertion library project, as it is slightly more complex due to code being spread across two GitHub repositories.
| Latest stable | Latest CI (how to use) | Build status | |
|---|---|---|---|
xunit.v3 |
 |
 |
 |
xunit |
 |
 |
 |
xunit.analyzers |
 |
 |
 |
xunit.runner.visualstudio |
 |
 |
 |
For complete CI package lists, please visit the feedz.io package search. A free login is required.
Help support this project by becoming a sponsor through GitHub Sponsors.