| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
Inside of your Astro + Starlight project, you'll see the following folders and files:
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ └── docs/
│ └── content.config.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.
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 |
The robots file references /gh-aw/sitemap.xml, which is the stable sitemap entrypoint for the docs site.
During a production build (npm run build), Astro generates /gh-aw/sitemap-index.xml, and the static /gh-aw/sitemap.xml entrypoint points crawlers at that generated sitemap index. The generated sitemap index is not available when running the local development server (npm run dev).
If a CI pipeline or automated tool checks the generated sitemap index URL during a local preview, it will receive a 404 response. To verify the production sitemap flow, run npm run build followed by npm run preview.
This docs site is deployed as a GitHub Pages project site under /gh-aw/ (see base: '/gh-aw/' in astro.config.mjs).
Root-level endpoints on https://github.github.com/ (for example /robots.txt) are controlled by the main github.github.com site, not this repository.
Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.
| Back | FazBrowse Home | New Git URL |