linkding/docs
2024-09-19 06:12:19 +02:00
..
public Add documentation website (#833) 2024-09-17 15:33:53 +02:00
src Add go-linkding to community projects (#836) 2024-09-19 06:12:19 +02:00
.gitignore Add documentation website (#833) 2024-09-17 15:33:53 +02:00
astro.config.mjs Add documentation website (#833) 2024-09-17 15:33:53 +02:00
package-lock.json Add documentation website (#833) 2024-09-17 15:33:53 +02:00
package.json Add documentation website (#833) 2024-09-17 15:33:53 +02:00
README.md Add documentation website (#833) 2024-09-17 15:33:53 +02:00
tsconfig.json Add documentation website (#833) 2024-09-17 15:33:53 +02:00

Starlight Starter Kit: Basics

Built with Starlight

npm create astro@latest -- --template starlight

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
└── 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.