Repository files navigation

This repository contains the source files used to generate thepester.dev website.

The website pages are written in markdown files using the.mdx format and are located in the/docs folder.

🔥One exception: the pages in the "Command Reference" section are auto-generated from Pester'sComment Based Help. Please do not create pull requests for these command reference pages here, but instead fix the correspondingPester PowerShell source code inpester/Pester repository. For example to changeInvoke-Pester command reference, you need to change the helpin this file.

To submit an update:

1. update the markdown.mdx file(s)
2. submit a pull request

The website is built using:

• Docusaurus 2, a modern static website generator written in React
• Alt3.Docusaurus.Powershell, a Powershell Get-Help to markdown generator

• Node.js
• Yarn

To install all required dependencies and start a local development server:

yarnyarn start

Because the website is using Docusaurus as the underlying technology:

• please refer to theDocusaurus 2 Documentation for usage informationand available customization options
• please report technical issues at theDocusaurus Repository

The global CSS overrides for the Pester website are found insrc/css/custom.css

The Pester website uses interactive React tables. To change the content of the tables,simply update the correlating.json configuration file as can be seen inthis example.

To upgrade docusaurus to a more recent version:

1. Editpackage.json
2. Manually bump the version number of these dependency packages:

   @docusaurus/core": "^2.2.0",@docusaurus/preset-classic": "^2.2.0",

3. Runyarn install
4. Submit a pull request with (only) these updated files:
   • package.json
   • yarn.lock

In the interest of fostering an open and welcoming environment, we ascontributors and maintainers pledge to making participation in our project andour community a harassment-free experience for everyone, regardless of age, bodysize, disability, ethnicity, gender identity and expression, level ofexperience, nationality, personal appearance, race, religion, or sexual identityand orientation.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement atcoc@pester.dev. All complaints will be reviewed and investigated promptly and fairly.

Read the full code of conduct