pesde/docs
2024-10-28 17:07:01 +01:00
..
.vscode feat(docs): init docs site 2024-10-28 17:07:01 +01:00
public feat(docs): init docs site 2024-10-28 17:07:01 +01:00
src feat(docs): init docs site 2024-10-28 17:07:01 +01:00
.gitignore feat(docs): init docs site 2024-10-28 17:07:01 +01:00
.prettierrc feat(docs): init docs site 2024-10-28 17:07:01 +01:00
astro.config.mjs feat(docs): init docs site 2024-10-28 17:07:01 +01:00
bun.lockb feat(docs): init docs site 2024-10-28 17:07:01 +01:00
package.json feat(docs): init docs site 2024-10-28 17:07:01 +01:00
README.md feat(docs): init docs site 2024-10-28 17:07:01 +01:00
tailwind.config.ts feat(docs): init docs site 2024-10-28 17:07:01 +01:00
tsconfig.json feat(docs): init docs site 2024-10-28 17:07:01 +01:00

Starlight Starter Kit: Tailwind

Built with Starlight

npm create astro@latest -- --template starlight/tailwind

Open in StackBlitz Open with CodeSandbox Deploy to Netlify 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
├── tailwind.config.mjs
└── 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.