- Notifications
You must be signed in to change notification settings - Fork4
Docs for Formwerk
NotificationsYou must be signed in to change notification settings
formwerkjs/formwerk.dev
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
npm create astro@latest -- --template starlight
🧑🚀Seasoned astronaut? Delete this file. Have fun!
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.jsonStarlight looks for.md or.mdx files in thesrc/content/docs/ directory. Each file is exposed as a route based on its file name.
Images can be added tosrc/assets/ and embedded in Markdown with a relative link.
Static assets, like favicons, can be placed in thepublic/ 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 atlocalhost: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 likeastro add,astro check |
npm run astro -- --help | Get help using the Astro CLI |
Check outStarlight’s docs, readthe Astro documentation, or jump into theAstro Discord server.
About
Docs for Formwerk