{"id":27610529,"url":"https://github.com/pester/docs","last_synced_at":"2025-04-22T23:29:19.668Z","repository":{"id":37269785,"uuid":"228910543","full_name":"pester/docs","owner":"pester","description":"Source files for the Pester website.","archived":false,"fork":false,"pushed_at":"2025-04-08T02:01:03.000Z","size":10002,"stargazers_count":41,"open_issues_count":21,"forks_count":78,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-15T20:58:31.210Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://pester.dev","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pester.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing/feature-requests.mdx","funding":null,"license":"LICENSE.txt","code_of_conduct":"code_of_conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["nohwnd","fflaten"],"open_collective":"pester"}},"created_at":"2019-12-18T19:47:15.000Z","updated_at":"2025-03-12T10:07:59.000Z","dependencies_parsed_at":"2023-09-23T05:43:28.525Z","dependency_job_id":"11247703-9518-4584-a076-fbffe63cbbce","html_url":"https://github.com/pester/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pester%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pester%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pester%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pester%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pester","download_url":"https://codeload.github.com/pester/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250339739,"owners_count":21414406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-04-22T23:29:19.049Z","updated_at":"2025-04-22T23:29:19.659Z","avatar_url":"https://github.com/pester.png","language":"MDX","funding_links":["https://github.com/sponsors/nohwnd","https://github.com/sponsors/fflaten","https://opencollective.com/pester"],"categories":[],"sub_categories":[],"readme":"[![Netlify](https://img.shields.io/netlify/40fe79e6-b973-4855-b0c7-f1ab101d1f0f?label=Netlify\u0026style=flat-square)](https://app.netlify.com/sites/pester-docs/deploys/40fe79e6-b973-4855-b0c7-f1ab101d1f0f)\n[![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)\n\n# Pester Docs\n\nThis repository contains the source files used to generate the [pester.dev](https://pester.dev) website.\n\nThe website pages are written in markdown files using the `.mdx` format and are located in the `/docs` folder.\n\n🔥 **One exception**: the pages in the \"Command Reference\" section are auto-generated from Pester's\n[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\nPester 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).\n\n## Contributing\n\nTo submit an update:\n\n1. update the markdown `.mdx` file(s)\n2. submit a pull request\n\n## Local Development\n\nThe website is built using:\n\n- [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator written in React\n- [Alt3.Docusaurus.Powershell](https://docusaurus-powershell.netlify.com/), a Powershell Get-Help to markdown generator\n\n### Requirements\n\n- [Node.js](https://nodejs.org/en/download/)\n- [Yarn](https://yarnpkg.com/en/)\n\n### Installation\n\nTo install all required dependencies and start a local development server:\n\n```bash\nyarn\nyarn start\n```\n\n## Website Customization\n\nBecause the website is using Docusaurus as the underlying technology:\n\n- please refer to the [Docusaurus 2 Documentation](https://v2.docusaurus.io/) for usage information\n  and available customization options\n- please report technical issues at the [Docusaurus Repository](https://github.com/facebook/docusaurus/issues)\n\n### Styling\n\nThe global CSS overrides for the Pester website are found in `src/css/custom.css`\n\n### Tables\n\nThe Pester website uses interactive React tables. To change the content of the tables,\nsimply update the correlating `.json` configuration file as can be seen in\n[this example](https://github.com/pester/docs/blob/main/docs/additional-resources/articles.table.js).\n\n### Bumping Docusaurus\n\nTo upgrade docusaurus to a more recent version:\n\n1. Edit `package.json`\n2. Manually bump the version number of these dependency packages:\n    ```json\n    @docusaurus/core\": \"^2.2.0\",\n    @docusaurus/preset-classic\": \"^2.2.0\",\n    ```\n3. Run `yarn install`\n4. Submit a pull request with (only) these updated files:\n   - `package.json`\n   - `yarn.lock`\n\n## Code of Conduct\n\nIn the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to making participation in our project and\nour community a harassment-free experience for everyone, regardless of age, body\nsize, disability, ethnicity, gender identity and expression, level of\nexperience, nationality, personal appearance, race, religion, or sexual identity\nand orientation.\n\nInstances 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.\n\n[Read the full code of conduct](code_of_conduct.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpester%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpester%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpester%2Fdocs/lists"}