trueberryless.org / starlight-save-file-component
Mirror of
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

starlight-save-file-component / docs / README.md
at main 54 lines 2.6 kB view raw view rendered
trueberryless basic setup
70800437
1# Starlight Starter Kit: Basics 2 3[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) 4 5``` 6pnpm create astro@latest -- --template starlight 7``` 8 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) 13 14> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! 15 16## 🚀 Project Structure 17 18Inside 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 33Starlight 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 35Images can be added to `src/assets/` and embedded in Markdown with a relative link. 36 37Static assets, like favicons, can be placed in the `public/` directory. 38 39## 🧞 Commands 40 41All commands are run from the root of the project, from a terminal: 42 43| Command | Action | 44| :------------------------ | :----------------------------------------------- | 45| `pnpm install` | Installs dependencies | 46| `pnpm dev` | Starts local dev server at `localhost:4321` | 47| `pnpm build` | Build your production site to `./dist/` | 48| `pnpm preview` | Preview your build locally, before deploying | 49| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` | 50| `pnpm astro -- --help` | Get help using the Astro CLI | 51 52## 👀 Want to learn more? 53 54Check 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).