forked from kumio/starlite-template
@astrojs/starlite boilerplate without client-side js
- Astro 71.4%
- JavaScript 14.8%
- MDX 9.1%
- TypeScript 4.7%
|
|
||
|---|---|---|
| .vscode | Initial commit from Astro | |
| patches | patch @expressive-code/core to skip bundling tabindex client-side js | |
| public | Initial commit from Astro | |
| src | override starlight components to omit client-side js | |
| .gitignore | Initial commit from Astro | |
| .npmrc | chore: package meta | |
| astro.config.mjs | override starlight components to omit client-side js | |
| package-lock.json | base: disable sharp imageService | |
| package.json | base: trim script tags from output in build | |
| README.md | update README | |
| tsconfig.json | Initial commit from Astro | |
Starlite Starter Kit
Minimal @astrojs/starlite boilerplate with client-side js disabled (and dependent functionality disabled).
This is for when you want a truly static site.
git clone https://codeberg.org/kumio/starlite-template
🧑🚀 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/
│ └── 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.
🧞 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.