Skip to content

Documentation ​

Year Planner for React is a source-available React component for long-range annual planning. This page is the entry point for the developer guides.

Documentation map ​

TopicPage
Getting startedgetting-started.md
Classic year layoutclassic-year-layout.md
Controlled APIcontrolled-api.md
Visibility semanticsvisibility.md
Selection and keyboardinteraction.md (keyboard map: accessibility.md)
Themingtheming.md
Localizationlocalization.md
Customization and holidayscustomization.md
Inspector and tooltipinspector-tooltip.md
Dynamic monthsdynamic-months.md
Printprint.md
Accessibility statusaccessibility.md
Browser test selection and shardingbrowser-tests.md
Performance statusperformance.md
Limitationslimitations.md
Migrationmigration.md
FAQfaq.md
Licence and permitted useslicensing.md

Reference and evidence ​

Published sites ​

The documentation site is one GitHub Pages artifact:

PathContent
/year-planner/VitePress home, guide, tutorials, how-tos and examples
/year-planner/storybook/The static Storybook catalogue
/year-planner/api/The generated TypeDoc reference
/year-planner/localization.htmlLanguages and message overrides

This is a project site, so the base path is /year-planner/. There is no custom domain. The repository is public, Pages is enabled with GitHub Actions, and the site is live at https://blendsdk.github.io/year-planner/. The build accepts DOCS_BASE_PATH=/ when a custom domain is added later.

Publishing the site ​

The docs-site workflow builds the combined artifact. Pushing to main builds and uploads it; publication stays a manual workflow_dispatch run with deploy: true from main. The one-time setup is complete: the repository is public, Pages uses GitHub Actions, and the github-pages environment is configured. The build does not depend on a stored secret; the deploy job uses the GitHub OIDC token. The uploaded artifact is docs/.vitepress/dist.

Building the site locally ​

bash
pnpm docs:dev                  # VitePress at /year-planner/
pnpm docs:site                 # packages, Storybook, TypeDoc, VitePress, copy, verify
pnpm docs:site -- --check-only # verify the last build without rebuilding
pnpm docs:preview              # preview the last VitePress build

The VitePress dev server proxies /year-planner/storybook to a Storybook dev server on http://localhost:6006, so the live examples work while you edit either side. Run pnpm storybook in another terminal.

Package status ​

The packages are published to npm at 0.3.2 with provenance. 0.3.0 was the unprovenanced bootstrap that created the package names. Install the component with pnpm add @blendsdk/react-year-planner; see getting-started.md.

Free for internal use. Built with VitePress, Storybook and TypeDoc.