Vivliostyle Theme Simple Report

Use

In vivliostyle.config.js:

module.exports = {
  theme: '@yas-ako/vivliostyle-theme-simple-report',
};

If you want to add your CSS:

module.exports = {
  theme: [
    '@yas-ako/vivliostyle-theme-simple-report',
    // add your CSS 
  ],
};

Dev

Files

@yas-ako/vivliostyle-theme-simple-report
├── LICENSE
├── README.md
├── example
│   ├── assets                            // auto generated
│   │   └── Logo (Mark + Type).png        // auto generated
│   └── default.md                        // 🖋
├── package.json
├── theme.css                             // 🖋
└── vivliostyle.config.js

example: Contain sample manuscripts using your theme.

Commands

Run vivliostyle preview to preview your theme.css.

To watch file changes, use preview script.

npm run preview
# or
yarn preview

You can specify your CSS file and manuscript file for preview in vivliostyle.config.js:

module.exports = {
  language: 'en',
  theme: ['node_modules/@vivliostyle/theme-base', '.'],
  entry: [
      'example/default.md',
      // and more...
  ],
}

Run vivliostyle-theme-scripts validate before publishing your package.

npm run validate
# or
yarn validate