https://github.com/oxidemod/oxide.docs
Official documentation for the Oxide modding framework
https://github.com/oxidemod/oxide.docs
documentation
Last synced: 6 months ago
JSON representation
Official documentation for the Oxide modding framework
- Host: GitHub
- URL: https://github.com/oxidemod/oxide.docs
- Owner: OxideMod
- Created: 2023-05-27T02:19:48.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-18T11:29:33.000Z (6 months ago)
- Last Synced: 2025-08-18T13:26:12.560Z (6 months ago)
- Topics: documentation
- Language: TypeScript
- Homepage: https://docs.oxidemod.com
- Size: 1.28 MB
- Stars: 3
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Oxide.Docs
This repository contains the source files for the Oxide documentation. The documentation is built using [VitePress](https://vitepress.dev/).
## Contributing
### Requirements
- [Node.js](https://nodejs.org/) (v20 or higher)
### Dependencies
To get started, you will need to install the dependencies. You can do this by running the following command:
```bash
npm install
```
### Development
To start the development server, run the following command:
```bash
npm run docs:dev
```
### Production
To preview the production build of the documentation, run the following command:
```bash
npm run docs:build
```
This can be previewed by running the following command:
```bash
npm run docs:preview
```
### Code Style
The project uses EditorConfig, Prettier, and pre-commit hooks to ensure consistent code style across the codebase.
When you commit changes, pre-commit hooks will automatically format your code according to our style guidelines.
To manually format files:
```bash
# Format all supported files
npm run format
# Check code style
npm run lint
# Also check code style
npm run check
```