diff --git a/README.md b/README.md index f9f6d31..6b175ec 100644 --- a/README.md +++ b/README.md @@ -1,54 +1 @@ -# Starlight Starter Kit: Basics - -[![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 [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). +# Ayo's Guides - Pragmatic Guides for Discerning Tech Hobbyists and Professionals diff --git a/astro.config.mjs b/astro.config.mjs index 1b39364..8170874 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -1,28 +1,30 @@ // @ts-check -import { defineConfig } from 'astro/config'; -import starlight from '@astrojs/starlight'; +import { defineConfig } from "astro/config"; +import starlight from "@astrojs/starlight"; // https://astro.build/config export default defineConfig({ - integrations: [ - starlight({ - title: 'My Docs', - social: { - github: 'https://github.com/withastro/starlight', - }, - sidebar: [ - { - label: 'Guides', - items: [ - // Each item here is one entry in the navigation menu. - { label: 'Example Guide', slug: 'guides/example' }, - ], - }, - { - label: 'Reference', - autogenerate: { directory: 'reference' }, - }, - ], - }), - ], + integrations: [ + starlight({ + title: "Ayo's Guides", + social: { + mastodon: "https://social.ayco.io", + blueSky: "https://bsky.app/profile/did:plc:hhpuzxrbpurathqyj2fuvnrs", + email: "mailto:ayo@ayco.io", + }, + sidebar: [ + { + label: "Guides", + items: [ + // Each item here is one entry in the navigation menu. + { label: "Get Started", slug: "guides/get-started" }, + ], + }, + { + label: "References", + autogenerate: { directory: "references" }, + }, + ], + }), + ], }); diff --git a/src/content/docs/guides/example.md b/src/content/docs/guides/get-started.md similarity index 94% rename from src/content/docs/guides/example.md rename to src/content/docs/guides/get-started.md index ebd0f3b..6862f35 100644 --- a/src/content/docs/guides/example.md +++ b/src/content/docs/guides/get-started.md @@ -1,5 +1,5 @@ --- -title: Example Guide +title: Get Started description: A guide in my new Starlight docs site. --- diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index 664b681..f83527c 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -1,26 +1,26 @@ --- -title: Welcome to Starlight +title: Welcome to Ayo's Guides description: Get started building your docs site with Starlight. template: splash hero: - tagline: Congrats on setting up a new Starlight project! - image: - file: ../../assets/houston.webp + tagline: ...for the Discerning Tech Hobbyists and Professionals +# image: +# file: ../../assets/houston.webp actions: - - text: Example Guide - link: /guides/example/ + - text: Get Started + link: /guides/get-started/ icon: right-arrow - - text: Read the Starlight docs - link: https://starlight.astro.build + - text: About the Author + link: https://ayo.ayco.io/about icon: external variant: minimal --- import { Card, CardGrid } from '@astrojs/starlight/components'; -## Next steps - - +{/* ## Next steps */} +{/* + Edit `src/content/docs/index.mdx` to see this page change. @@ -33,4 +33,4 @@ import { Card, CardGrid } from '@astrojs/starlight/components'; Learn more in [the Starlight Docs](https://starlight.astro.build/). - + */} diff --git a/src/content/docs/reference/example.md b/src/content/docs/references/example.md similarity index 94% rename from src/content/docs/reference/example.md rename to src/content/docs/references/example.md index 0224f09..92f9214 100644 --- a/src/content/docs/reference/example.md +++ b/src/content/docs/references/example.md @@ -1,5 +1,5 @@ --- -title: Example Reference +title: About the website description: A reference page in my new Starlight docs site. ---