paper-api Documentation

1. Project Overview & Quickstart (PaperMC/paper-api) Copy Chapter

1. Project Overview & Quickstart (PaperMC/paper-api) Copy Chapter

paper-api

Open-source repository PaperMC/paper-api

Repository Details Copy Section

• Repository: PaperMC/paper-api
• Primary Language: Code

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (PaperMC/docs) Copy Chapter

docs [](https://discord.gg/papermc)

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 Copy Chapter

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

Prerequisites Copy Section

• node 22
• pnpm

Local Development Copy Section

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 will
be instantly reflected live without the need to restart the development server or reload the page in
your browser. Edit away!

Building Copy Section

$ pnpm run 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 Copy Chapter

The PaperMC Documentation (e.g., .md files in the /src/content/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.

2. Official Technical Reference & Guides (PaperMC/docs) Copy Chapter

docs [](https://discord.gg/papermc)

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 Copy Chapter

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

Prerequisites Copy Section

• node 22
• pnpm

Local Development Copy Section

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 will
be instantly reflected live without the need to restart the development server or reload the page in
your browser. Edit away!

Building Copy Section

$ pnpm run 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 Copy Chapter

The PaperMC Documentation (e.g., .md files in the /src/content/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.