https://github.com/xkonti/nimforue-docs

Documentation page for NimForUE Unreal Engine plugin
https://github.com/xkonti/nimforue-docs

docs nim nim-lang unreal-engine

Last synced: about 1 month ago
JSON representation

Documentation page for NimForUE Unreal Engine plugin

• Host: GitHub
• URL: https://github.com/xkonti/nimforue-docs
• Owner: Xkonti
• License: mit
• Created: 2024-05-14T17:02:04.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-07-15T21:34:55.000Z (6 months ago)
• Last Synced: 2024-07-16T02:01:27.976Z (6 months ago)
• Topics: docs, nim, nim-lang, unreal-engine
• Language: JavaScript
• Homepage: https://nimforue.pages.dev
• Size: 479 KB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nim for UE documentation

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)

These docs are work in progress. If you have experience with [NimForUE](https://github.com/jmgomez/NimForUE) please feel free to contribute.

# Developing the docs with Starlight

This project has [GitHub codespaces](https://github.com/features/codespaces) and [devcontainers](https://containers.dev/) 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](https://pnpm.io/) 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:

| Command                   | Action                                           |

| :------------------------ | :----------------------------------------------- |

| `pnpm install`             | Installs dependencies                            |

| `pnpm run dev`             | Starts local dev server at `localhost:4321`      |

| `pnpm run build`           | Build your production site to `./dist/`          |

| `pnpm run preview`         | Preview your build locally, before deploying     |

| `pnpm run astro ...`       | Run CLI commands like `astro add`, `astro check` |

| `pnpm run astro -- --help` | Get help using the Astro CLI                     |

## 👀 Want to learn more?

Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).