Skip to content

Commit

Permalink
light starlight customization for course builder
Browse files Browse the repository at this point in the history
  • Loading branch information
joelhooks committed Nov 20, 2023
1 parent e408003 commit fe0d07c
Show file tree
Hide file tree
Showing 8 changed files with 46 additions and 82 deletions.
53 changes: 0 additions & 53 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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).
12 changes: 4 additions & 8 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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' },
},
}
],
}),
],
Expand Down
Binary file added docs/src/assets/badass.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions docs/src/assets/badass.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/src/assets/houston.webp
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -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
16 changes: 8 additions & 8 deletions docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
11 changes: 0 additions & 11 deletions docs/src/content/docs/reference/example.md

This file was deleted.

1 comment on commit fe0d07c

@vercel
Copy link

@vercel vercel bot commented on fe0d07c Nov 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.