https://github.com/patchstack/documentation
Patchstack documentation
https://github.com/patchstack/documentation
Last synced: 5 months ago
JSON representation
Patchstack documentation
- Host: GitHub
- URL: https://github.com/patchstack/documentation
- Owner: patchstack
- Created: 2024-01-30T13:20:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-24T16:52:22.000Z (6 months ago)
- Last Synced: 2025-12-26T07:42:13.026Z (6 months ago)
- Language: JavaScript
- Size: 60.6 MB
- Stars: 1
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Patchstack Documentation
## What is Patchstack
Patchstack is a powerful tool that helps to protect your WordPress applications from attacks and identify security vulnerabilities within all your WordPress plugins, themes, and core. It is powered by the WordPress ecosystem's most active community of ethical hackers. Patchstack is trusted by leading WordPress experts such as Pagely, Cloudways, GridPane, Plesk, and others.
[**Check our website**](https://patchstack.com/)
[**Join our Community**](https://discord.com/servers/patchstack-alliance-1024691600619745334)
## Installation
**Prerequisites**
**Node.js** - v18.14.1 or higher.
1. Fork the repository first.
2. `git clone` the forked repository on your computer.
3. Run `npm install` and `npm start`
## Project structure
**Patchstack Documentation** is built on top of [**Astro**🚀](https://astro.build/) and [**Astro Starlight**✨](https://starlight.astro.build/).
```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
| ├── libs
| ├── pages
| ├── styles
│ └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
```
The part that should interest you the most is the `src/content/docs` folder. All the website content is there in Markdown or MDX format.
## Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |