No description
  • TypeScript 84.7%
  • JavaScript 15%
  • Shell 0.3%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-07-25 21:34:22 +02:00
.husky Add logo, pre-commit hooks, README, and Codeberg Pages deploy 2026-07-15 20:39:55 +02:00
demo Add logo, pre-commit hooks, README, and Codeberg Pages deploy 2026-07-15 20:39:55 +02:00
locale add + distribute locale 2026-07-25 07:18:01 +02:00
scripts add + distribute locale 2026-07-25 07:18:01 +02:00
src switch to pnpm + adjustment to main packages 2026-07-22 18:07:44 +02:00
test switch to pnpm + adjustment to main packages 2026-07-22 18:07:44 +02:00
.gitignore add gitignore 2026-07-02 07:51:44 +02:00
.prettierignore Add fwtoolkit lint/format setup 2026-07-02 22:25:09 +02:00
.prettierrc.json Add fwtoolkit lint/format setup 2026-07-02 22:25:09 +02:00
AGENTS.md switch to pnpm + adjustment to main packages 2026-07-22 18:07:44 +02:00
eslint.config.mjs Add fwtoolkit lint/format setup 2026-07-02 22:25:09 +02:00
jest.config.js add ZipFileCreator mock for tests and bump document dependency 2026-07-14 08:33:37 +02:00
LICENSE first commit 2026-07-02 07:50:18 +02:00
logo.svg Add logo, pre-commit hooks, README, and Codeberg Pages deploy 2026-07-15 20:39:55 +02:00
package.json 0.1.14 2026-07-25 21:34:22 +02:00
pnpm-lock.yaml update dependencies 2026-07-25 10:36:40 +02:00
README.md Use absolute Codeberg URL for README logo and include logo.svg in package files 2026-07-25 19:49:02 +02:00
tsconfig.json first commit 2026-07-02 07:50:18 +02:00

@fiduswriter/books-document

@fiduswriter/books-document

Book-level importers and exporters for Fidus Writer


What it does

Implements book-level (composite/multi-document) importers and exporters for Fidus Writer. Builds on top of @fiduswriter/document — reuses its single-document export filters and composes them into book-level outputs.

Supported export formats

Format Extension Description
Native Fidus Book .fidusbook Full book archive with all chapters and assets
DOCX .docx Microsoft Word document
ODT .odt OpenDocument Text
LaTeX .tex LaTeX document
HTML .html Web page
EPUB .epub E-book
BITS .xml Book Interchange Tag Suite (JATS for books)
Print .pdf PDF via Vivliostyle

Exports

Main entry exports:

Export Description
FIDUSBOOK_VERSION Current Fidus Book format version number

Subpath exports

Path Description
./schema Book document schema
./importer/native Native .fidusbook format importer
./exporter/native Native .fidusbook format exporter
./exporter/docx Book to DOCX exporter
./exporter/odt Book to ODT exporter
./exporter/latex Book to LaTeX exporter
./exporter/html Book to HTML exporter
./exporter/epub Book to EPUB exporter
./exporter/print Book to PDF exporter
./exporter/bits Book to BITS exporter
./exporter/tools Shared exporter utilities
./i18n Internationalization strings
./types TypeScript type definitions

Installation

npm install @fiduswriter/books-document

Usage

import {FIDUSBOOK_VERSION} from "@fiduswriter/books-document"
import {NativeBookExporter} from "@fiduswriter/books-document/exporter/native"
import {DocxBookExporter} from "@fiduswriter/books-document/exporter/docx"

Development

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

License

AGPL-3.0 — see LICENSE for details.