diff options
Diffstat (limited to 'app/packages/web/README.md')
| -rw-r--r-- | app/packages/web/README.md | 60 |
1 files changed, 40 insertions, 20 deletions
diff --git a/app/packages/web/README.md b/app/packages/web/README.md index 6a1764536..f9f6d31c6 100644 --- a/app/packages/web/README.md +++ b/app/packages/web/README.md @@ -1,34 +1,54 @@ -## Usage +# Starlight Starter Kit: Basics -Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`. +[](https://starlight.astro.build) -This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template. - -```bash -$ npm install # or pnpm install or yarn install ``` +npm create astro@latest -- --template starlight +``` + +[](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics) +[](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics) +[](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics) +[](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) -### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs) +> π§βπ **Seasoned astronaut?** Delete this file. Have fun! -## Available Scripts +## π Project Structure -In the project directory, you can run: +Inside of your Astro + Starlight project, you'll see the following folders and files: + +``` +. +βββ public/ +βββ src/ +β βββ assets/ +β βββ content/ +β β βββ docs/ +β βββ content.config.ts +βββ astro.config.mjs +βββ package.json +βββ tsconfig.json +``` -### `npm run dev` or `npm start` +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. -Runs the app in the development mode.<br> -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +Images can be added to `src/assets/` and embedded in Markdown with a relative link. -The page will reload if you make edits.<br> +Static assets, like favicons, can be placed in the `public/` directory. -### `npm run build` +## π§ Commands -Builds the app for production to the `dist` folder.<br> -It correctly bundles Solid in production mode and optimizes the build for the best performance. +All commands are run from the root of the project, from a terminal: -The build is minified and the filenames include the hashes.<br> -Your app is ready to be deployed! +| 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 | -## Deployment +## π Want to learn more? -You can deploy the `dist` folder to any static host provider (netlify, surge, now, etc.) +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). |
