/vfm-viewer

Experimental real-time typesetting previewer for Vivliostyle Flavored Markdown.

Primary LanguageTypeScript

vfm-viewer

npm version

Experimental real-time typesetting previewer for VFM.

Usage

See example.

$ vfm-viewer preview --help
vfm-viewer preview [file]

Preview typesetting result

Options:
      --version  Show version number                                   [boolean]
  -c, --config   Path to config file [string] [default: "vivliostyle.config.js"]
  -h, --help     Show help                                             [boolean]
  -p, --port                                            [number] [default: 3000]

Configuration

vfm-viewer supports some properties of vivliostyle.config.js.

theme

Only local .css file is supported. Local directory and NPM package are not supported.

theme: "./example.md"

size

Presets are not supported yet.

size: "960px,720px"