BestiumDocs

Official documentation for the Bestium library for PaperMC.

View the live site: docs.bestium.jeme.cz

---

Development

Development happens in the dev branch, which is later merged into prod. Every push to prod triggers a GitHub Actions workflow that builds and deploys the site.

Requirements

This project uses pnpm.

Start Development Server

pnpm dev

Build for Production

pnpm build

Constants

Constants are dynamic strings (usually versions) that get injected into code blocks and inline code.

• Inline usage:
  Inline code blocks automatically replace constants.
  Example:

  Download the latest version of Bestium: `{const::LATEST_BESTIUM}`

• Code block usage:
  To replace constants in a code block, add the replace modifier.
  Example:

  ```groovy replace
  plugins {
      id 'io.papermc.paperweight.userdev' version '{const::LATEST_USERDEV}'
  }
  ```

Constants are defined in astro.config.ts.

The remark plugin for constant replacement is located at src/util/remark/replace-constants.ts.

Javadoc Links

You can reference Bestium Javadoc in links using the following formats:

• Type (class, interface, enum, etc.):

  [Injectable](jd::cz.jeme.bestium.api.inject.Injectable)

• Package:

  [entities](jd::cz.jeme.bestium.api.entity)

• Method:

  [Injectable#addBestiumAdditionalSaveData](jd::cz.jeme.bestium.api.inject.Injectable#addBestiumAdditionalSaveData(net.minecraft.world.level.storage.ValueOutput output))

The remark plugin for Javadoc linking is located at src/util/remark/javadoc.ts.