JavaScript API

Functions

• build
• create
• createBuiltinCmykConversion
• createBuiltinCmykConversionReplacement
• createBuiltinGrayConversion
• createBuiltinGrayConversionReplacement
• createBuiltinRgbConversionReplacement
• createIccConversion
• createIccConversionReplacement
• createTheme
• createVitePlugin
• defineConfig
• preview
• validateTheme
• VFM

Interfaces

• CMYKValue
• ColorConversionOptions
• IccConversionOptions
• ReplaceFunctionContext
• StringifyMarkdownOptions
• TemplateVariable
• ThemeTemplateVariable
• ThemeValidationResult

Type Aliases

• CmykConversion
• CmykConvertFunction
• ImageConversionReplacement
• Metadata
• ReplaceFunction
• StructuredDocument
• StructuredDocumentSection
• TocCompose
• VivliostyleConfigSchema
• VivliostylePackageMetadata
• VivliostylePackageMetadata

Variables

• readMetadata

build()

build(options): Promise<void>

Build publication file(s) from the given configuration.

import { build } from '@vivliostyle/cli';
build({
  configPath: './vivliostyle.config.js',
  logLevel: 'silent',
});

create()

create(options): Promise<void>

Scaffold a new Vivliostyle project.

createBuiltinCmykConversion()

createBuiltinCmykConversion(options?): CmykConversion

Creates a conversion for cmyk.fallback that converts RGB colors to CMYK using MuPDF's DeviceCMYK color space.

createBuiltinCmykConversionReplacement()

createBuiltinCmykConversionReplacement(options?): ImageConversionReplacement

Creates a replacement that converts images to DeviceCMYK.

createBuiltinGrayConversion()

createBuiltinGrayConversion(options?): CmykConversion

Creates a conversion for cmyk.fallback that converts RGB colors to grayscale and maps the result to the K channel.

createBuiltinGrayConversionReplacement()

createBuiltinGrayConversionReplacement(options?): ImageConversionReplacement

Creates a replacement that converts images to DeviceGray.

createBuiltinRgbConversionReplacement()

createBuiltinRgbConversionReplacement(options?): ImageConversionReplacement

Creates a replacement that converts images to DeviceRGB.

createIccConversion()

createIccConversion(options): CmykConversion

Creates a conversion for cmyk.fallback that converts RGB colors through an ICC profile. CMYK profiles return all four channels; grayscale profiles map to the K channel.

createIccConversionReplacement()

createIccConversionReplacement(options): ImageConversionReplacement

Creates a replacement that converts images using a destination ICC profile and returns an image in the corresponding Device color space.

createTheme()

createTheme(options): Promise<void>

Scaffold a new Vivliostyle theme package.

createVitePlugin()

createVitePlugin(inlineConfig?): Promise<Plugin<any>[]>

defineConfig()

defineConfig(config): VivliostyleConfigSchema

Define the configuration for Vivliostyle CLI.

preview()

preview(options): Promise<ViteDevServer>

Open a browser for previewing the publication.

validateTheme()

validateTheme(options): Promise<ThemeValidationResult[]>

Validate a Vivliostyle theme package.

VFM()

VFM(options?, metadata?): Processor

Create Unified processor for Markdown AST and Hypertext AST.

CMYKValue

ColorConversionOptions

Options shared by color conversions and image conversion replacements.

IccConversionOptions

Options for conversion using a caller-provided destination ICC profile.

ReplaceFunctionContext

Values available while a replacement function is running.

StringifyMarkdownOptions

Option for convert Markdown to a stringify (HTML).

Declared as interface so that downstream consumers (e.g. vivliostyle-cli) see a stable nominal name instead of v.InferInput<typeof StringifyMarkdownOptionsSchema>. The latter form causes TypeScript to expand the schema's structural shape during declaration emit and pulls non-portable .pnpm/... paths through pnpm isolated installs (TS2742). The compile-time check below pins this interface to the schema, so a drift in either direction is rejected.

TemplateVariable

ThemeTemplateVariable

ThemeValidationResult

CmykConversion

CmykConversion = Readonly<v.InferInput<typeof CmykConversionSchema>>

CmykConvertFunction

CmykConvertFunction = (rgb) => CMYKValue | null | Promise<CMYKValue | null>

Converts an unmapped RGB color on a 0-10000 scale to CMYK, or returns null to leave it unmapped.

ImageConversionReplacement

ImageConversionReplacement = Readonly<v.InferInput<typeof ImageConversionReplacementSchema>>

Metadata

Metadata = object

Metadata from Frontmatter.

ReplaceFunction

ReplaceFunction = (context) => mupdfType.Image | null | Promise<mupdfType.Image | null>

Returns an owned replacement image, transferring its ownership to Vivliostyle CLI, or null to decline the current match and continue to the next replacement candidate. The returned image must be created with the supplied mupdf module and must not be used or destroyed after it is returned. The current image may be returned directly to use it as the replacement.

StructuredDocument

StructuredDocument = object

StructuredDocumentSection

StructuredDocumentSection = object

TocCompose

TocCompose = ({ h }) => ({ heading, content, }) => ElementContent[]

VivliostyleConfigSchema

VivliostyleConfigSchema = BuildTask[] | BuildTask

VivliostylePackageMetadata

VivliostylePackageMetadata = SchemaWithPipe<readonly [Omit<ObjectSchema<{ template: SchemaWithPipe<readonly [RecordSchema<SchemaWithPipe<readonly [..., ..., ...]>, ObjectSchema<{ description: ...; name: ...; prompt: ...; source: ...; }, undefined>, undefined>, TitleAction<{[key: string]: object; }, "VivliostyleTemplateMetadata">]>; theme: SchemaWithPipe<readonly [ObjectSchema<{ author: SchemaWithPipe<...>; category: SchemaWithPipe<...>; name: SchemaWithPipe<...>; style: SchemaWithPipe<...>; topics: SchemaWithPipe<...>; }, undefined>, TitleAction<{ author?: ... | ...; category?: ... | ...; name?: ... | ...; style?: ... | ...; topics?: ... | ...; }, "VivliostyleThemeMetadata">]>; }, undefined>, "entries" | "~types" | "~run" | "~standard"> & object, TitleAction<{ template?: {[key: string]: object; }; theme?: { author?: string; category?: string; name?: string; style?: string; topics?: string[]; }; }, "VivliostylePackageMetadata">]>

VivliostylePackageMetadata

VivliostylePackageMetadata = v.InferInput<typeof VivliostylePackageMetadata>

readMetadata

const readMetadata: (md, customKeys?) => Metadata

Read metadata from Markdown frontmatter.

Keys that are not defined as VFM are treated as meta. If you specify a key name in customKeys, the key and its data type will be preserved and stored in custom instead of meta.