Skip to content

README.md

Latest commit

 

History

History
29 lines (20 loc) · 1.49 KB

README.md

File metadata and controls

29 lines (20 loc) · 1.49 KB
Raw

Docs site

The documentation site for this repository. It is built with NgMd on AnalogJS, Angular and Tailwind.

Run it

From the repository root:

pnpm install
pnpm docs:dev     # dev server on http://localhost:5173
pnpm docs:build   # production build in dist/apps/docs
pnpm docs:test    # unit tests for the build plugins
pnpm docs:deploy  # build, then deploy to Cloudflare Workers with wrangler

docs:deploy serves the prerendered pages in dist/apps/docs/analog/public as static assets, using wrangler.jsonc. Log in once with pnpm --filter pangular-inspector-docs exec wrangler login, or set CLOUDFLARE_API_TOKEN and CLOUDFLARE_ACCOUNT_ID in CI.

These scripts run Nx targets. The @nx/vite and @nx/vitest plugins infer them from vite.config.ts. You can also run any target directly, for example pnpm nx typecheck pangular-inspector-docs or pnpm nx preview pangular-inspector-docs.

Edit

  • Pages are markdown files in src/content. The path becomes the URL: src/content/inspectors/signals.md is served at /inspectors/signals.
  • Link between pages with relative .md paths, such as [Router](../inspectors/router.md), so the links also work on GitHub.
  • The sidebar, site name, links and site URL live in src/ngmd.config.ts.
  • Brand colors are CSS variables in src/styles.css.
  • The landing page is src/app/pages/index.page.ts.

The build fails on broken internal links and anchors, so run pnpm docs:build before you open a PR.