Skip to content

Commit 530f917

Browse files
committed
update readme
1 parent d440c94 commit 530f917

File tree

1 file changed

+3
-53
lines changed

1 file changed

+3
-53
lines changed

README.md

+3-53
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,4 @@
1-
# Starlight Starter Kit: Basics
1+
# Starlight Example on Code with CodingCat.dev
22

3-
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
4-
5-
```
6-
npm create astro@latest -- --template starlight
7-
```
8-
9-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
10-
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
11-
[![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)
12-
13-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
14-
15-
## 🚀 Project Structure
16-
17-
Inside of your Astro + Starlight project, you'll see the following folders and files:
18-
19-
```
20-
.
21-
├── public/
22-
├── src/
23-
│ ├── assets/
24-
│ ├── content/
25-
│ │ ├── docs/
26-
│ │ └── config.ts
27-
│ └── env.d.ts
28-
├── astro.config.mjs
29-
├── package.json
30-
└── tsconfig.json
31-
```
32-
33-
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.
34-
35-
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
36-
37-
Static assets, like favicons, can be placed in the `public/` directory.
38-
39-
## 🧞 Commands
40-
41-
All commands are run from the root of the project, from a terminal:
42-
43-
| Command | Action |
44-
| :------------------------ | :----------------------------------------------- |
45-
| `npm install` | Installs dependencies |
46-
| `npm run dev` | Starts local dev server at `localhost:4321` |
47-
| `npm run build` | Build your production site to `./dist/` |
48-
| `npm run preview` | Preview your build locally, before deploying |
49-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
50-
| `npm run astro -- --help` | Get help using the Astro CLI |
51-
52-
## 👀 Want to learn more?
53-
54-
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).
3+
Starlight: https://starlight.astro.build/
4+
YouTube: https://youtube.com/live/sF6UcV3moZg?feature=share

0 commit comments

Comments
 (0)