https://github.com/selenite-geos/docs
Documentation for the Selenite project.
https://github.com/selenite-geos/docs
documentation geos selenite
Last synced: 2 months ago
JSON representation
Documentation for the Selenite project.
- Host: GitHub
- URL: https://github.com/selenite-geos/docs
- Owner: Selenite-GEOS
- Created: 2024-08-07T10:06:02.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-19T19:19:04.000Z (almost 2 years ago)
- Last Synced: 2025-05-29T20:24:03.552Z (about 1 year ago)
- Topics: documentation, geos, selenite
- Language: TypeScript
- Homepage: https://selenite-geos.github.io/docs/
- Size: 654 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Selenite Docs
[](https://starlight.astro.build)
Documentation of the Selenite project, a web-based graphical interface for the [GEOS Simulation Framework](https://github.com/GEOS-DEV/GEOS).
## Configuration
The build of the documentation can be configured using environment variables. The following variables are available:
- `SITE_ORIGIN`: The origin of the site, used for generating the sitemap. If not set, the sitemap will not be generated.
- `BASE_PATH`: The base path of the site. All routes will be prefixed with this path.
## 🚀 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 |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm 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).
## TODO
- Improve lightning css configuration
- Investigate if Logo blinking can be rectified with svg or placeholder