KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #ai-agent #claude-code #mcp #typescript #codex #cli #rust #deepseek-harness

docs

★ 44 Open GitHub ↗

Source files for the Pester website.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Netlify](https://img.shields.io/netlify/40fe79e6-b973-4855-b0c7-f1ab101d1f0f?label=Netlify&style=flat-square)](https://app.netlify.com/sites/pester-docs/deploys/40fe79e6-b973-4855-b0c7-f1ab101d1f0f)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-square)](https://www.contributor-covenant.org/version/2/0/code_of_conduct)

# Pester Docs

This repository contains the source files used to generate the [pester.dev](https://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](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help?view=powershell-7.1). Please do not create pull requests for these command reference pages here, but instead fix the corresponding
Pester PowerShell source code in [pester/Pester](https://github.com/pester/pester) repository. For example to change [Invoke-Pester command reference](https://pester.dev/docs/commands/Invoke-Pester), you need to change the help [in this file](https://github.com/pester/Pester/blob/main/src/Pester.ps1#L258-L276).

## 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](https://docusaurus.io/), a modern static website generator written in React
- [Alt3.Docusaurus.Powershell](https://docusaurus-powershell.netlify.com/), a Powershell Get-Help to markdown generator

### Requirements

- [Node.js](https://nodejs.org/en/download/)
- [pnpm](https://pnpm.io/)

### Installation

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

```bash
pnpm install
pnpm start
```

## Website Customization

Because the website is using Docusaurus as the underlying technology:

- please refer to the [Docusaurus Documentation](https://docusaurus.io/) for usage information
  and available customization options
- please report technical issues at the [Docusaurus Repository](https://github.com/facebook/docusaurus/issues)

### 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](https://github.com/pester/docs/blob/main/docs/additional-resources/articles.table.js).

### Bumping Docusaurus

Dependabot is used to update dependencies regularly. If you need to upgrade manually, follow these steps:

1. Edit `package.json`
2. Manually bump the version number of these dependency packages:
    ```json
    "@docusaurus/core": "^3.10.2",
    "@docusaurus/faster": "^3.10.2",
    "@docusaurus/preset-classic": "^3.10.2",
    "@docusaurus/module-type-aliases": "^3.10.2",
    "@docusaurus/types": "^3.10.2"
    ```
3. Run `pnpm install`
4. Submit a pull request with (only) these updated files:
   - `package.json`
   - `pnpm-lock.yaml`

## 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 coc@pester.dev. All complaints will be reviewed and investigated promptly and fairly.

[Read the full code of conduct](code_of_conduct.md)

docs

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README