Skip to content

LOCAL_DEVELOPMENT.md

Latest commit

 

History

History
74 lines (49 loc) · 1.07 KB

LOCAL_DEVELOPMENT.md

File metadata and controls

74 lines (49 loc) · 1.07 KB

Local Development

This site runs with Astro and Starlight.

Requirements

  • Node.js 22.x
  • npm

If you use nvm:

nvm install 22
nvm use 22

Install Dependencies

npm install

Run The Dev Server

npm run dev

Default local URL:

  • http://localhost:4321/

Build The Site

npm run build

OpenAPI Sync Behavior

Before dev and build, the repo runs:

npm run sync:openapi

If a local sibling repo exists at:

../pyMC_Repeater/repeater/web/openapi.yaml

the checked-in repeater OpenAPI file will be refreshed from that source.

If that local repo is not present, the docs site falls back to the checked-in spec in:

public/openapi/repeater.yaml

Content Locations

  • Main docs content: src/content/docs/
  • pyMC Core docs: src/content/docs/projects/pymc-core/
  • pyMC Repeater docs: src/content/docs/projects/pymc-repeater/
  • pyMC HA Integration docs: src/content/docs/projects/pymc-ha-integration/

Common Commands

npm run dev
npm run build
npm run preview