Repository files navigation

This is the repository for all project documentation under the PaperMC umbrella. Content in thisrepository is published todocs.papermc.io for viewing.

How to get docs running on your local machine for development.

• node
• pnpm

1. Clone the repository. If you plan to make changes, create a fork first!

$ git clone https://github.com/PaperMC/docs

2. Install all required dependencies.

$ pnpm install

3. Start the development server.

$ pnpm run dev

This will start a local development server and open a browser window. The majority of changes willbe instantly reflected live without the need to restart the development server or reload the page inyour browser. Edit away!

$ pnpm run build

This command builds a production-ready deployment into thebuild directory. These files are readyto be hosted on any static content server.

The PaperMC Documentation (e.g.,.md files in the/docs folder) isCC-BY-SA-4.0 licensed.

The supporting code isBSD-2-Clause licensed.

The PaperMC logomark is subject to itsown terms and does notinherit a license from any of the projects it represents.