initial commit

This commit is contained in:
Ayo Ayco 2025-01-26 22:28:40 +01:00
parent 472e1b47c4
commit 63fa33db0d
5 changed files with 40 additions and 91 deletions

View file

@ -1,54 +1 @@
# Starlight Starter Kit: Basics # Ayo's Guides - Pragmatic Guides for Discerning Tech Hobbyists and Professionals
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
```
npm create astro@latest -- --template starlight
```
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## 🚀 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.
## 🧞 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 [Starlights docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).

View file

@ -1,28 +1,30 @@
// @ts-check // @ts-check
import { defineConfig } from 'astro/config'; import { defineConfig } from "astro/config";
import starlight from '@astrojs/starlight'; import starlight from "@astrojs/starlight";
// https://astro.build/config // https://astro.build/config
export default defineConfig({ export default defineConfig({
integrations: [ integrations: [
starlight({ starlight({
title: 'My Docs', title: "Ayo's Guides",
social: { social: {
github: 'https://github.com/withastro/starlight', mastodon: "https://social.ayco.io",
}, blueSky: "https://bsky.app/profile/did:plc:hhpuzxrbpurathqyj2fuvnrs",
sidebar: [ email: "mailto:ayo@ayco.io",
{ },
label: 'Guides', sidebar: [
items: [ {
// Each item here is one entry in the navigation menu. label: "Guides",
{ label: 'Example Guide', slug: 'guides/example' }, items: [
], // Each item here is one entry in the navigation menu.
}, { label: "Get Started", slug: "guides/get-started" },
{ ],
label: 'Reference', },
autogenerate: { directory: 'reference' }, {
}, label: "References",
], autogenerate: { directory: "references" },
}), },
], ],
}),
],
}); });

View file

@ -1,5 +1,5 @@
--- ---
title: Example Guide title: Get Started
description: A guide in my new Starlight docs site. description: A guide in my new Starlight docs site.
--- ---

View file

@ -1,26 +1,26 @@
--- ---
title: Welcome to Starlight title: Welcome to Ayo's Guides
description: Get started building your docs site with Starlight. description: Get started building your docs site with Starlight.
template: splash template: splash
hero: hero:
tagline: Congrats on setting up a new Starlight project! tagline: ...for the Discerning Tech Hobbyists and Professionals
image: # image:
file: ../../assets/houston.webp # file: ../../assets/houston.webp
actions: actions:
- text: Example Guide - text: Get Started
link: /guides/example/ link: /guides/get-started/
icon: right-arrow icon: right-arrow
- text: Read the Starlight docs - text: About the Author
link: https://starlight.astro.build link: https://ayo.ayco.io/about
icon: external icon: external
variant: minimal variant: minimal
--- ---
import { Card, CardGrid } from '@astrojs/starlight/components'; import { Card, CardGrid } from '@astrojs/starlight/components';
## Next steps {/* ## Next steps */}
{/*
<CardGrid stagger> <CardGrid>
<Card title="Update content" icon="pencil"> <Card title="Update content" icon="pencil">
Edit `src/content/docs/index.mdx` to see this page change. Edit `src/content/docs/index.mdx` to see this page change.
</Card> </Card>
@ -33,4 +33,4 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
<Card title="Read the docs" icon="open-book"> <Card title="Read the docs" icon="open-book">
Learn more in [the Starlight Docs](https://starlight.astro.build/). Learn more in [the Starlight Docs](https://starlight.astro.build/).
</Card> </Card>
</CardGrid> </CardGrid> */}

View file

@ -1,5 +1,5 @@
--- ---
title: Example Reference title: About the website
description: A reference page in my new Starlight docs site. description: A reference page in my new Starlight docs site.
--- ---