Documentation for all active NUnit projects
This repository serves the content that is found at https://docs.nunit.org.
The docs site is a project within the NUnit organization. Read the vision at VISION.md to understand more about how the documentation fits into the overall organization and how it supports the other projects.
choco install docfx -y
)cd docs
docfx serve
and navigate to http://localhost:8080/_site
Fancy using GitHub Codespaces for your work on these docs? Or want to work in the environment locally? You can!
build
(we've taken care of the rest for you)serve
(we've taken care of the rest for you)lint
(we've taken care of the rest for you)spellcheck
(we've taken care of the rest for you)snippets
(we've taken care of the rest for you)We'll be working on follow-ups to make this more user-friendly, but it's now workable.
markdownlint-cli2
: npm install markdownlint-cli2 -g
/
, not /docs
)markdownlint-cli2 --config ".github/linters/.markdownlint.yml" "docs/**/*.md"
We'd love your contributions! See The contributing guide for how to get involved.
The NUnit source code is in a separate repository from the docs, so we typically generate this at build time by copying
published code into a build-specific folder (/code-output
). From there, docfx
transforms the xmldoc comments that
are alongside the DLLs into HTML files.
Sometimes you may need/want to reproduce this locally. You can take the following steps to do so:
.zip
file of the release contentsnet6.0
, into a code-outputs
folder in the root of the
repository.docfx
command as you normally would../github/workflows
.gh-pages
branch, using a personal access token
that is stored in the repository's settings.gh-pages
branch, and the DNS of docs.nunit.org
points there.