Nim for UE documentation

These docs are work in progress. If you have experience with NimForUE please feel free to contribute.

Developing the docs with Starlight

This project has GitHub codespaces and devcontainers already setup, providing a development environment for the docs. This way you can use the same environment as the docs are built in - directly from the browser or VSCode.

Manual project setup

1. Have pnpm installed
2. Clone the repository
3. Install dependencies: pnpm install
4. Start the development server: pnpm dev

🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:

.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   ├── docs/
│   │   └── config.ts
│   └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

Images can be added to src/assets/ and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project, from a terminal:

👀 Want to learn more?

Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.