https://github.com/interledger/blank-starlight
Blank starlight repository for our docs team to test and play around with
https://github.com/interledger/blank-starlight
Last synced: 3 months ago
JSON representation
Blank starlight repository for our docs team to test and play around with
- Host: GitHub
- URL: https://github.com/interledger/blank-starlight
- Owner: interledger
- Created: 2025-04-01T09:38:44.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-30T13:36:53.000Z (10 months ago)
- Last Synced: 2025-08-04T14:27:28.854Z (10 months ago)
- Language: Astro
- Size: 104 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Blank Starlight
This is the source code for the blank Starlight hosted at [](). It is built with [Starlight](https://starlight.astro.build/getting-started/), a documentation framework based on [Astro](https://astro.build/). It is meant for our docs team to experiment and test out their ideas with the documentation before implementing it for real on any of the actual doc sites.
## 🚀 Project Structure
Inside of your Astro + Starlight project, you'll see the following folders and files:
```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ └── content.config.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.
## Local development
We are using [Bun](https://bun.sh/) in this repository, but you could theoretically use the package manager of your choice. To install Bun, run
```sh
curl -fsSL https://bun.sh/install | bash
```
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `bun install` | Installs dependencies |
| `bun run dev` | Starts local dev server at `localhost:1107` |
| `bun run build` | Build your production site to `./dist/` |
| `bun run preview` | Preview your build locally, before deploying |
| `bun run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `bun run astro -- --help` | Get help using the Astro CLI |
You can substitute the `bun` commands with whatever package manager of your choice uses.
## 👀 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).