summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md49
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
+
+[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](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).