asears / docs

Source files for the Pester website.

Pester Docs

This repository contains the source files used to generate the pester.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's Comment Based Help. Please do not create pull requests for these command reference pages here, but instead fix the corresponding Pester PowerShell source code in pester/Pester repository. For example to change Invoke-Pester command reference, you need to change the help in this file.

Contributing

To submit an update:

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

Local Development

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

Requirements

• Node.js
• Yarn

Installation

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

yarn
yarn start

Website Customization

Because the website is using Docusaurus as the underlying technology:

• please refer to the Docusaurus 2 Documentation for usage information and available customization options
• please report technical issues at the Docusaurus Repository

Styling

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

Tables

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 in this example.

Bumping Docusaurus

To upgrade docusaurus to a more recent version:

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

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

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

Code of Conduct

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

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email protected]. All complaints will be reviewed and investigated promptly and fairly.

Read the full code of conduct