docs

This is the repository for all project documentation under the PaperMC umbrella. Content in this repository is published to docs.papermc.io for viewing.

Getting Started

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

Prerequisites

• node
• yarn

Local Development

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.

$ yarn

3. Start the development server

$ yarn dev

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

Building

$ yarn build

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

License

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

The supporting code is BSD-2-Clause licensed.

The PaperMC logomark is subject to its own terms and does not inherit a license from any of the projects it represents.

Special Thanks

Preview and production hosting for this project has been provided for free by Vercel. Thank you!