chuangcaleb_obsidian-founta.../docs
2026-05-25 23:47:34 +08:00
..
public feat: use .ico for favicon 2025-04-02 18:37:41 +08:00
src refactor: extract out ai from content/docs 2026-05-25 23:47:34 +08:00
.gitignore feat: scaffold starlight docs 2025-03-30 16:54:25 +08:00
astro.config.mjs refactor: extract out ai from content/docs 2026-05-25 23:47:34 +08:00
package.json docs: upgrade docs packages 2025-08-23 12:05:31 +08:00
README.md feat: scaffold starlight docs 2025-03-30 16:54:25 +08:00
tsconfig.json feat: scaffold starlight docs 2025-03-30 16:54:25 +08:00

Obsidian Fountain Editor Documentation

Built with Starlight

🚀 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
pnpm install Installs dependencies
pnpm dev Starts local dev server at localhost:4321
pnpm build Build your production site to ./dist/
pnpm preview Preview your build locally, before deploying
pnpm astro ... Run CLI commands like astro add, astro check
pnpm astro -- --help Get help using the Astro CLI

👀 Want to learn more?

Check out Starlights docs, read the Astro documentation, or jump into the Astro Discord server.