Skip to content

Repository files navigation

Immediate.Dev

Public website and documentation for ImmediatePlatform, built with SvelteKit, Tailwind CSS, shadcn-svelte, and MDSvex.

The application is based on code-gio/svelte-docs-starter at commit 12b09f1.

Developing

Install Node.js 26 and pnpm 10, then restore dependencies and start the development server:

pnpm install
pnpm dev

Validation

pnpm check
pnpm lint
pnpm build

pnpm build prerenders the site into build/ and generates its Pagefind search index.

Documentation content

Documentation pages live under src/content/docs. Page order comes from each file's order frontmatter value; sidebar section order comes from src/lib/docs/config.ts.

To add another package, create its content directory and add one autogeneration entry to the sidebar configuration.

Deployment

The Generate Docs GitHub Actions workflow installs dependencies with pnpm, performs a static production build, and publishes build/ to GitHub Pages. It is started manually with workflow_dispatch and reads the canonical URL from the SITE_URL repository variable.

About

Public Website for the ImmediatePlatform

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages