|
1 | | -# Starlight Starter Kit: Basics |
| 1 | +This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). |
2 | 2 |
|
3 | | -[](https://starlight.astro.build) |
| 3 | +## Getting Started |
4 | 4 |
|
5 | | -``` |
6 | | -npm create astro@latest -- --template starlight |
7 | | -``` |
8 | | - |
9 | | -[](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics) |
10 | | -[](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics) |
11 | | -[](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics) |
12 | | -[](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) |
13 | | - |
14 | | -> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! |
| 5 | +First, run the development server: |
15 | 6 |
|
16 | | -## 🚀 Project Structure |
| 7 | +```bash |
| 8 | +npm run dev |
| 9 | +# or |
| 10 | +yarn dev |
| 11 | +# or |
| 12 | +pnpm dev |
| 13 | +# or |
| 14 | +bun dev |
| 15 | +``` |
17 | 16 |
|
18 | | -Inside of your Astro + Starlight project, you'll see the following folders and files: |
| 17 | +Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
19 | 18 |
|
20 | | -``` |
21 | | -. |
22 | | -├── public/ |
23 | | -├── src/ |
24 | | -│ ├── assets/ |
25 | | -│ ├── content/ |
26 | | -│ │ ├── docs/ |
27 | | -│ │ └── content.config.ts |
28 | | -│ └── env.d.ts |
29 | | -├── astro.config.mjs |
30 | | -├── package.json |
31 | | -└── tsconfig.json |
32 | | -``` |
| 19 | +You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. |
33 | 20 |
|
34 | | -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. |
| 21 | +This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. |
35 | 22 |
|
36 | | -Images can be added to `src/assets/` and embedded in Markdown with a relative link. |
| 23 | +## Learn More |
37 | 24 |
|
38 | | -Static assets, like favicons, can be placed in the `public/` directory. |
| 25 | +To learn more about Next.js, take a look at the following resources: |
39 | 26 |
|
40 | | -## 🧞 Commands |
| 27 | +- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
| 28 | +- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
41 | 29 |
|
42 | | -All commands are run from the root of the project, from a terminal: |
| 30 | +You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! |
43 | 31 |
|
44 | | -| Command | Action | |
45 | | -| :------------------------ | :----------------------------------------------- | |
46 | | -| `npm install` | Installs dependencies | |
47 | | -| `npm run dev` | Starts local dev server at `localhost:4321` | |
48 | | -| `npm run build` | Build your production site to `./dist/` | |
49 | | -| `npm run preview` | Preview your build locally, before deploying | |
50 | | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | |
51 | | -| `npm run astro -- --help` | Get help using the Astro CLI | |
| 32 | +## Deploy on Vercel |
52 | 33 |
|
53 | | -## 👀 Want to learn more? |
| 34 | +The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
54 | 35 |
|
55 | | -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). |
| 36 | +Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. |
0 commit comments