GeyserWebsite/README.md

Website

This is the Geyser website is built using Docusaurus 3.

Contributing

See CONTRIBUTING.md for more information.

Project Structure

• blog/: Blog markdown files
• docs/: Wiki markdown files
  • api/: Rest API documentation
  • floodgate/: Floodgate documentation
  • geyser/: Geyser documentation
  • other/: Other projects documentation
• i18n/: Translations for the website
• openapi/: OpenAPI spec files to auto-generate REST API documentation
• src/: Source of the website
  • components/: React components
  • css/: Styles
  • data/: Data files, such as hosting providers and supported Minecraft versions
  • pages/: Pages of the website
  • renderer/: Renderer for thumbnails
  • theme/: Overrides base Docusaurus theme, such as importing fa icons
  • types/: TypeScript types
• static/: Static content
  • img/: Images
• docusaurus.config.ts: Docusaurus configuration file
• package.json: Node.js project file
• sidebar.ts: Site sidebar configuration
• tsconfig.json: TypeScript configuration file
• yarn.lock: Yarn lock file for Node.js dependencies

Quick Start

git clone https://github.com/GeyserMC/GeyserWebsite
cd GeyserWebsite
yarn
yarn start