diff --git a/docs/README.md b/docs/README.md index f95661b59..e69de29bb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,53 +0,0 @@ -# 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) - -> πŸ§‘β€πŸš€ **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/ -β”‚ β”‚ └── 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). diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 9eacfd175..98d0cb344 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -5,22 +5,18 @@ import starlight from '@astrojs/starlight'; export default defineConfig({ integrations: [ starlight({ - title: 'My Docs', + title: 'Course Builder', social: { - github: 'https://github.com/withastro/starlight', + github: 'https://github.com/joelhooks/course-builder', }, sidebar: [ { label: 'Guides', items: [ // Each item here is one entry in the navigation menu. - { label: 'Example Guide', link: '/guides/example/' }, + { label: 'Getting Started', link: '/guides/getting-started/' }, ], - }, - { - label: 'Reference', - autogenerate: { directory: 'reference' }, - }, + } ], }), ], diff --git a/docs/src/assets/badass.png b/docs/src/assets/badass.png new file mode 100644 index 000000000..f9c1a7022 Binary files /dev/null and b/docs/src/assets/badass.png differ diff --git a/docs/src/assets/badass.svg b/docs/src/assets/badass.svg new file mode 100644 index 000000000..289e277e0 --- /dev/null +++ b/docs/src/assets/badass.svg @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/docs/src/assets/houston.webp b/docs/src/assets/houston.webp deleted file mode 100644 index 930c16497..000000000 Binary files a/docs/src/assets/houston.webp and /dev/null differ diff --git a/docs/src/content/docs/guides/example.md b/docs/src/content/docs/guides/getting-started.md similarity index 55% rename from docs/src/content/docs/guides/example.md rename to docs/src/content/docs/guides/getting-started.md index ebd0f3bc7..413adb509 100644 --- a/docs/src/content/docs/guides/example.md +++ b/docs/src/content/docs/guides/getting-started.md @@ -1,11 +1,23 @@ --- -title: Example Guide -description: A guide in my new Starlight docs site. +title: Getting Started +description: This will help you create a new Course Builder project. --- Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. Writing a good guide requires thinking about what your users are trying to do. +## Clone the Repository + +```bash +git clone https://www.github.com/joelhooks/course-builder +``` + +## Install Dependencies + +```bash +pnpm install +``` + ## Further reading - Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the DiΓ‘taxis framework diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx index 117179dbb..993e7e175 100644 --- a/docs/src/content/docs/index.mdx +++ b/docs/src/content/docs/index.mdx @@ -1,18 +1,18 @@ --- -title: Welcome to Starlight -description: Get started building your docs site with Starlight. +title: Build a Course Platform +description: Everything you need to build your own course platform. template: splash hero: - tagline: Congrats on setting up a new Starlight project! + tagline: Everything you need to build your own course platform. image: - file: ../../assets/houston.webp + file: ../../assets/badass.svg actions: - - text: Example Guide - link: /guides/example/ + - text: Getting Started Guide + link: /guides/getting-started/ icon: right-arrow variant: primary - - text: Read the Starlight docs - link: https://starlight.astro.build + - text: Visit Course Builder + link: https://coursebuilder.dev icon: external --- diff --git a/docs/src/content/docs/reference/example.md b/docs/src/content/docs/reference/example.md deleted file mode 100644 index ac8cfa8bc..000000000 --- a/docs/src/content/docs/reference/example.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Example Reference -description: A reference page in my new Starlight docs site. ---- - -Reference pages are ideal for outlining how things work in terse and clear terms. -Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what your documenting. - -## Further reading - -- Read [about reference](https://diataxis.fr/reference/) in the DiΓ‘taxis framework