Astro and Starlight source for omarchyqol.com.
npm ci
npm run devThe development server runs at http://localhost:3000.
| Path | Purpose |
|---|---|
src/pages/ |
Landing page, robots and video sitemap |
src/content/docs/docs/ |
Overview and plugin documentation |
src/content.config.ts |
Frontmatter validation |
src/components/ |
Shared website components |
src/components/starlight/ |
Starlight overrides |
src/layouts/ |
Landing-page HTML layout |
src/styles/ |
Theme, headers, landing, docs, media |
src/config/site.mjs |
Site metadata and sitemap exclusions |
public/media/ |
Versioned screenshots and videos |
src/content/docs/ is Starlight's collection directory. Its docs/ subfolder
creates the /docs/ URL prefix.
Plugin frontmatter supplies the details and landing-page cards. pluginOrder
sets card order. Optional Markdown appears after the generated plugin details.
Keep video dates quoted and media filenames versioned.
Sidebar labels and order are configured in astro.config.mjs. When a plugin
enters or leaves Labs, update its status and NOINDEX_PATHS in
src/config/site.mjs together.
src/styles/custom.css imports the fonts and six stylesheets. Keep responsive
rules with their corresponding styles; import order affects the cascade.
npm run verifyRuns formatting, Astro diagnostics, the Cloudflare build, SEO checks, and
redirect tests. Build output is written to dist/.
GitHub Actions runs these checks on pull requests. A successful push to main
deploys the checked build to Cloudflare, then updates the redirect Worker. The
workflow can also be run manually from main.
Set the CLOUDFLARE_API_TOKEN Actions secret and CLOUDFLARE_ACCOUNT_ID
Actions variable before the first deployment. The token needs Worker script and
KV write access for the account, plus zone read and Worker route write access
for the two website zones.
For a manual deployment from a verified local build:
npx wrangler deploy --config dist/server/wrangler.json
npx wrangler deploy --config wrangler.redirects.jsoncThe wordmark comes from the Omarchy repository. This project is independent of Omarchy and Omacom.
