diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..8a6d7e7 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# Starlight Starter Kit: Basics + +[](https://starlight.astro.build) + +``` +yarn create astro@latest -- --template starlight +``` + +> π§βπ **Seasoned astronaut?** Delete this file. Have fun! + +## π Project Structure + +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 +``` + +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. + +Images can be added to `src/assets/` and embedded in Markdown with a relative link. + +Static assets, like favicons, can be placed in the `public/` directory. + +## π§ Commands + +All commands are run from the root of the project, from a terminal: + +| Command | Action | +| :------------------------ | :----------------------------------------------- | +| `yarn install` | Installs dependencies | +| `yarn dev` | Starts local dev server at `localhost:4321` | +| `yarn build` | Build your production site to `./dist/` | +| `yarn preview` | Preview your build locally, before deploying | +| `yarn astro ...` | Run CLI commands like `astro add`, `astro check` | +| `yarn astro -- --help` | Get help using the Astro CLI | + +## π Want to learn more? + +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). |