rdelaage
/
castopod
mirror of https://code.castopod.org/adaures/castopod.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
castopod/docs
History
Yassine Doghri 281eefc6a3 build(docs): add type declarations for virtual:starlight 2024-05-30 09:42:03 +00:00
..
public fix(docs): add base to og image using env variable 2024-05-28 09:51:28 +00:00
scripts ci(gitlabci): filter out docs src languages not declared in .i18n-filter file before build 2022-04-14 12:09:40 +00:00
src build(docs): add type declarations for virtual:starlight 2024-05-30 09:42:03 +00:00
.gitignore docs: change vitepress with astro's starlight 2024-05-21 16:07:56 +00:00
.gitlab-ci.yml fix(docs): add base to og image using env variable 2024-05-28 09:51:28 +00:00
README.md docs: change vitepress with astro's starlight 2024-05-21 16:07:56 +00:00
astro.config.mjs docs: add DocsVersion component to navigate through different docs versions 2024-05-29 17:28:24 +00:00
package.json docs: change vitepress with astro's starlight 2024-05-21 16:07:56 +00:00
pnpm-lock.yaml docs: change vitepress with astro's starlight 2024-05-21 16:07:56 +00:00
postcss.config.cjs docs: change vitepress with astro's starlight 2024-05-21 16:07:56 +00:00
tailwind.config.cjs docs: change vitepress with astro's starlight 2024-05-21 16:07:56 +00:00
tsconfig.json docs: change vitepress with astro's starlight 2024-05-21 16:07:56 +00:00

README.md

Castopod Docs

Built with Starlight

pnpm 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.