Skip to content

godotlauncher/launcher-docs

Godot Launcher Documentation

This repository contains the source code for the official Godot Launcher Documentation, built using Docusaurus, a modern static site generator.

📖 Contributing

Contributions are always welcome! The Godot Launcher documentation is open source, just like the Godot Luncher Project.

Feel free to fix typos, improve, or add new content. To contribute:

  1. Fork the repo
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

Make sure to follow the existing structure and style for consistency.

Keep in mind that this documentation is the public face of the Godot Launcher project documentation. For that reason, major edits or structural changes should be approached thoughtfully. While you don’t need to submit a formal proposal, it’s highly recommended to open an issue in this repo or start a discussion in the Godot Launcher Discord, where community conversations about the website and project happen regularly.

🚀 Development

This website is built using Node.js 22+ and npm. To run it locally:

1. Fork the repository

First, fork the repository to your GitHub account:

  1. Go to the Godot Launcher Docs repository.
  2. Click the "Fork" button in the top-right corner.

Then, clone your forked repository:

git clone https://github.com/<your-username>/launcher-docs.git
cd launcher-docs

2. Install dependencies

npm install

3. Start the development server

npm run start

This will launch a local dev server at http://localhost:3000.

4. Test Build for production

It is important to test out your production build, generate the static site and run it locally to test things out.

npm run build

To preview the production build:

npm run serve

🧩 Project Structure

  • /blog - Blog articles
  • /src – Website source (components, pages, etc.)
  • /src/pages - Website pages
  • /static – Static assets (images, icons, etc.)
  • docusaurus.config.js – Site configuration

Feel free to reach out or open an issue if you spot something broken or unclear.

Releases

No releases published

Packages

No packages published