Skip to content

README.md

Latest commit

 

History

History
80 lines (53 loc) · 1.93 KB

README.md

File metadata and controls

80 lines (53 loc) · 1.93 KB

MSK Scripts — Documentation

Official documentation site for MSK Scripts — FiveM resources, Discord bots, and related ecosystem projects by Musiker15.

Live site: docu.msk-scripts.de

Built with Docusaurus 3 (TypeScript, React 19) and the @docusaurus/faster Rspack pipeline.

Requirements

  • Node.js >=20.0
  • Yarn 1 (Classic)

Installation

yarn

Local Development

yarn start

Starts a local dev server with hot-reload at http://localhost:3000.

Build

yarn build

Generates static content into the build/ directory, ready to be served by any static host.

Typecheck

yarn typecheck

Deployment

Deployment to GitHub Pages is handled automatically by the workflow in .github/workflows/.

Manual deploy (if needed):

# Using SSH
USE_SSH=true yarn deploy

# Using HTTPS
GIT_USER=<Your GitHub username> yarn deploy

Project Structure

.
├── blog/                  # Blog / changelog posts
├── docs/                  # Main documentation (FiveM scripts)
├── discord/               # Discord bot documentation
├── ecosystem/             # Ecosystem / integrations
├── guides/                # How-to guides
├── src/                   # React components, pages, custom CSS
├── static/                # Static assets (images, fonts, downloads)
└── docusaurus.config.ts   # Site configuration

Security

Found a vulnerability? Please see SECURITY.md for the disclosure process.

Dependency updates are managed by Dependabot. Pinned overrides for transitive dependencies live in the resolutions block of package.json.

Links