Skip to content

forceCalendar/docs

Repository files navigation

ForceCalendar Documentation

This is the central documentation hub for the ForceCalendar ecosystem.

Structure

  • /docs: General documentation, integration guides, and tutorials.
    • core/: Documentation for the @forcecalendar/core engine.
    • integration/: Guides for Web Components and Salesforce integration.
    • advanced/: Deep dives into performance and architecture.
  • /blog: Project updates and technical articles.
  • /static: Assets and images.

Getting Started

Prerequisites

  • Node.js 20+
  • npm

Installation

npm install

Local Development

# Start the Docusaurus development server
npm start

# Build for production
npm run build

# Generate API documentation (requires @forcecalendar/core)
npm run generate-api

Contributing

Please see the main project contribution guidelines. Documentation changes can be submitted via Pull Requests to the docs/ directory.

License

MIT

Releases

No releases published

Packages

No packages published