Web3Privacy Now Documentation
Find a file
2024-03-17 03:25:35 +01:00
.vscode migrate to starlight #8 2024-03-17 03:25:35 +01:00
public migrate to starlight #8 2024-03-17 03:25:35 +01:00
src migrate to starlight #8 2024-03-17 03:25:35 +01:00
.gitignore migrate to starlight #8 2024-03-17 03:25:35 +01:00
astro.config.mjs migrate to starlight #8 2024-03-17 03:25:35 +01:00
docs migrate to starlight #8 2024-03-17 03:25:35 +01:00
package-lock.json migrate to starlight #8 2024-03-17 03:25:35 +01:00
package.json migrate to starlight #8 2024-03-17 03:25:35 +01:00
README.md migrate to starlight #8 2024-03-17 03:25:35 +01:00
tsconfig.json migrate to starlight #8 2024-03-17 03:25:35 +01:00

Starlight Starter Kit: Basics

Built with Starlight

npm create astro@latest -- --template starlight

Open in StackBlitz Open with CodeSandbox Deploy with Vercel

🧑‍🚀 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/
│   │   └── config.ts
│   └── env.d.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
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

👀 Want to learn more?

Check out Starlights docs, read the Astro documentation, or jump into the Astro Discord server.