An open API service indexing awesome lists of open source software.

https://github.com/godotlauncher/launcher-docs

Godot Launcher Official Documentation SIte
https://github.com/godotlauncher/launcher-docs

docs docusaurus-v3 godot godot-engine godot-launcher open-source-project

Last synced: about 2 months ago
JSON representation

Godot Launcher Official Documentation SIte

Awesome Lists containing this project

README

          

# Godot Launcher Documentation

This repository contains the source code for the official **Godot Launcher Documentation**, built using [Docusaurus](https://docusaurus.io/), a modern static site generator.

## πŸ“– Contributing

Contributions are always welcome! The Godot Launcher documentation is open source, just like the [Godot Luncher](https://github.com/godotlauncher/launcher) 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](https://github.com/godotlauncher/launcher-docs).
2. Click the "Fork" button in the top-right corner.

Then, clone your forked repository:

```bash
git clone https://github.com//launcher-docs.git
cd launcher-docs
```

### 2. Install dependencies

```bash
npm install
```

### 3. Start the development server

```bash
npm run start
```

This will launch a local dev server at [http://localhost:3000](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.

```bash
npm run build
```

To preview the production build:

```bash
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.