https://github.com/louisescher/starlight-ion-theme

A sleek, modern theme for Starlight.
https://github.com/louisescher/starlight-ion-theme

astro starlight starlight-astro theme

Last synced: about 2 months ago
JSON representation

A sleek, modern theme for Starlight.

• Host: GitHub
• URL: https://github.com/louisescher/starlight-ion-theme
• Owner: louisescher
• License: mit
• Created: 2024-04-21T11:37:00.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-09-10T22:46:59.000Z (3 months ago)
• Last Synced: 2024-10-11T09:13:49.198Z (2 months ago)
• Topics: astro, starlight, starlight-astro, theme
• Language: TypeScript
• Homepage: https://louisescher.github.io/starlight-ion-theme/
• Size: 469 KB
• Stars: 18
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Starlight Starter Kit: Ion Theme

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

```

npm create astro@latest -- --template louisescher/starlight-ion-theme

```

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/louisescher/starlight-ion-theme)

[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/louisescher/starlight-ion-theme)

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flouisescher%2Fstarlight-ion-theme&project-name=my-starlight-ion-docs&repository-name=my-starlight-ion-docs)

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!

![158shots_so](https://github.com/louisescher/starlight-ion-theme/assets/66965600/64241499-8c8e-4672-bf4d-b2d8ff2a6862)

## 🚀 Project Structure

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

```

.

├── public/

├── src/

│   ├── assets/

│   ├── components/

│   ├── content/

│   │   ├── docs/

│   │   └── config.ts

│   ├── icons/

│   ├── schemas/

│   ├── styles/

│   ├── utils/

│   └── 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.

Any component overrides made by this theme can be found in `src/components/`, any icons are located in `src/icons/`, and all styles are

in the `src/styles/` directory.

To find out more, start your development server and check out the **Features** page.

## 🧞 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).