NimbusDB Docs

This repository contains the documentation site for NimbusDB, a next-generation in-memory ORM and reactive query engine for GameMaker.

Important

This project is archived due to the author no longer using GameMaker and has no plans for further development.

Live docs: NimbusDB Docs Main library: NimbusDB

Project Structure

├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   └── docs/
│   │       ├── getting-started/
│   │       ├── concepts/
│   │       ├── core/
│   │       ├── pipeline/
│   │       ├── joins/
│   │       ├── reactivity/
│   │       ├── io/
│   │       ├── migration/
│   │       ├── api-reference/
│   │       └── guides/
│   └── content.config.ts
├── astro.config.mjs
└── package.json

Each .md/.mdx file in src/content/docs/ corresponds to a page on the docs site, routed based on its folder structure. Sidebar navigation is configured in astro.config.mjs.

Development

Install dependencies:

pnpm install

Start the local dev server:

pnpm dev

This starts a local server at localhost:4321.

Build for production:

pnpm build

Preview the production build:

pnpm preview

License

This documentation is licensed under MIT License, same as the main NimbusDB project.