Skip to content

azdanov/docs

This branch is 1 commit behind AstroNvim/docs:refs/heads/main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b104af0 Β· Jan 2, 2025
Oct 5, 2023
Oct 10, 2023
Jan 2, 2025
Oct 9, 2023
Apr 1, 2024
Oct 16, 2023
Apr 1, 2024
Jul 31, 2024
Oct 9, 2023
Jan 2, 2025
Apr 1, 2024
Jan 2, 2025
Jan 2, 2025
Oct 9, 2023
Oct 9, 2023

Repository files navigation

Starlight Starter Kit: Basics

Built with Starlight

npm create astro@latest -- --template starlight

Open in StackBlitz Open with CodeSandbox

πŸ§‘β€πŸš€ 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 Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.

About

Site for AstroNvim

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • MDX 96.0%
  • JavaScript 2.7%
  • Other 1.3%