Skip to content

Commit 5bd30b5

Browse files
committed
Update README
1 parent 075ae52 commit 5bd30b5

File tree

1 file changed

+14
-46
lines changed

1 file changed

+14
-46
lines changed

README.md

+14-46
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,22 @@
1-
# Starlight Starter Kit: Basics
1+
# XIVAPI static pages
22

33
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
44

5-
```
6-
npm create astro@latest -- --template starlight
7-
```
5+
## Environment
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%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
7+
This repository uses [mise](https://mise.jdx.dev/) to manage the development
8+
environment. `mise install` will set up the necessary tools. Refer to
9+
`mise.toml` for required tool versions if not using mise for setup.
1310

14-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
15-
16-
## 🚀 Project Structure
17-
18-
Inside of your Astro + Starlight project, you'll see the following folders and files:
19-
20-
```
21-
.
22-
├── public/
23-
├── src/
24-
│ ├── assets/
25-
│ ├── content/
26-
│ │ ├── docs/
27-
│ └── content.config.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
11+
## Commands
4012

4113
All commands are run from the root of the project, from a terminal:
4214

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).
15+
| Command | Action |
16+
| :------------------------- | :----------------------------------------------- |
17+
| `pnpm install` | Installs dependencies |
18+
| `pnpm run dev` | Starts local dev server at `localhost:4321` |
19+
| `pnpm run build` | Build your production site to `./dist/` |
20+
| `pnpm run preview` | Preview your build locally, before deploying |
21+
| `pnpm run astro ...` | Run CLI commands like `astro add`, `astro check` |
22+
| `pnpm run astro -- --help` | Get help using the Astro CLI |

0 commit comments

Comments
 (0)