Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
},

// Windows users should clone repo in container volume or using WSL2
// If not, uncomment this to fix poor yarn/npm performance
// If not, uncomment this to fix poor pnpm/npm performance
// "mounts": [
// "source=pester-docs-node_modules,target=${containerWorkspaceFolder}/node_modules,type=volume"
// ],
Expand All @@ -23,7 +23,7 @@
],

// Use 'postCreateCommand' to run commands after the container is created.
"postCreateCommand": "yarn install",
"postCreateCommand": "pnpm install",

// Configure tool-specific properties.
"customizations": {
Expand Down
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
version: 2
updates:
# JavaScript/TypeScript dependencies (package.json + yarn.lock).
# JavaScript/TypeScript dependencies (package.json + pnpm-lock.yaml).
# Grouped so security and version updates arrive as a few PRs instead of
# one failing run per transitive advisory.
- package-ecosystem: "npm"
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*

# Editors
.vscode/*
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
.claude/settings.local.json
2 changes: 1 addition & 1 deletion .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"version": "0.2.0",
"configurations": [
{
"command": "yarn start --host 0.0.0.0 --poll 1000",
"command": "pnpm start --host 0.0.0.0 --poll 1000",
"name": "Start Docusaurus (with polling)",
"request": "launch",
"type": "node-terminal"
Expand Down
14 changes: 9 additions & 5 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,18 @@
"tasks": [
{
"label": "Start Docusaurus with polling",
"command": "yarn",
"type": "process",
// Polling for devcontainer support
"command": "pnpm",
"type": "process",
"args": [
"start",
"--poll"
// Allow access from outside the devcontainer
"--host",
"0.0.0.0",
// Polling every 1000ms for file watching in devcontainer
"--poll",
"1000"
],
"problemMatcher": []
}
]
}
}
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,28 +22,28 @@ To submit an update:

The website is built using:

- [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator written in React
- [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/)
- [Yarn](https://yarnpkg.com/en/)
- [pnpm](https://pnpm.io/)

### Installation

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

```bash
yarn
yarn start
pnpm install
pnpm start
```

## Website Customization

Because the website is using Docusaurus as the underlying technology:

- please refer to the [Docusaurus 2 Documentation](https://v2.docusaurus.io/) for usage information
- 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)

Expand All @@ -59,18 +59,21 @@ simply update the correlating `.json` configuration file as can be seen in

### Bumping Docusaurus

To upgrade docusaurus to a more recent version:
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": "^2.2.0",
@docusaurus/preset-classic": "^2.2.0",
"@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 `yarn install`
3. Run `pnpm install`
4. Submit a pull request with (only) these updated files:
- `package.json`
- `yarn.lock`
- `pnpm-lock.yaml`

## Code of Conduct

Expand Down
7 changes: 7 additions & 0 deletions netlify.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Netlify build settings. Kept in the repo instead of the Netlify UI so they are
# versioned and reviewed with the rest of the code. This file wins over the UI.
# Node version comes from .nvmrc. Redirects come from static/_redirects.

[build]
command = "pnpm build"
publish = "build"
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.10.2",
"@docusaurus/types": "^3.10.1"
"@docusaurus/types": "^3.10.2"
},
"resolutions": {
"serialize-javascript": "7.0.7",
Expand All @@ -43,5 +43,6 @@
"last 1 firefox version",
"last 1 safari version"
]
}
},
"packageManager": "pnpm@10.34.5"
}
Loading