No description
- TypeScript 84.7%
- JavaScript 15%
- Shell 0.3%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .husky | ||
| demo | ||
| locale | ||
| scripts | ||
| src | ||
| test | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc.json | ||
| AGENTS.md | ||
| eslint.config.mjs | ||
| jest.config.js | ||
| LICENSE | ||
| logo.svg | ||
| package.json | ||
| pnpm-lock.yaml | ||
| README.md | ||
| tsconfig.json | ||
@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) |
.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.