What it does

Holds Fidus Writer-specific shared page chrome, utilities, and ProseMirror state plugins that are reused between the standalone editor and bibliography manager applications. These are not generic enough to live in fwtoolkit.

Exports

Components

| Export | Description | |--------|-------------| | baseBodyTemplate | Base HTML body template with common meta tags and CSS | | FeedbackTab | Feedback and support sidebar tab | | SiteMenu | Top-level site navigation menu with plugin registry |

State plugins

| Export path | Description | |-------------|-------------| | ./state_plugins/contributor_input | Contributor field input plugin for ProseMirror | | ./state_plugins/tag_input | Tag field input plugin for ProseMirror |

Types

The package exports 26 TypeScript interfaces and types for app configuration, menu items, routes, settings, users, and plugin registrations. See the TypeScript declarations in dist/ for the full API.

Installation

npm install @fiduswriter/common

Usage

import {baseBodyTemplate, FeedbackTab, SiteMenu} from "@fiduswriter/common"
import {contributorInputPlugin} from "@fiduswriter/common/state_plugins/contributor_input"
import {tagInputPlugin} from "@fiduswriter/common/state_plugins/tag_input"

Development

npm install          # Install dependencies
npm run build        # Compile TypeScript to dist/
npm run typecheck    # Check types without emitting
npm run lint         # Lint with ESLint
npm run format:check # Check formatting with Prettier

License

AGPL-3.0 — see LICENSE for details.