Skip to content

PocoPota/vivliostyle-theme-academic-pp

Repository files navigation

Vivliostyle Theme Academic PP

npm: version npm: total downloads npm: license

An academic theme for Vivliostyle

Functions

  • Two-Column Layout
  • Image Row
  • Abstract
  • KeyWords
  • Enable / Disable Page Counter
  • Enanle / Disable Abstract Title
  • Font Selection
  • Compact Mode

See Feature Details: (In Progress)

Docs

Here's the document link! ↓

https://pocopota.github.io/vs-theme-academic-pp-docs/

Use

In vivliostyle.config.js:

module.exports = {
  theme: 'vivliostyle-theme-academic-pp',
};

If you want to add your CSS:

module.exports = {
  theme: [
    'vivliostyle-theme-academic-pp',
    // add your CSS 
  ],
};

Dev

Files

vivliostyle-theme-academic-pp
├── LICENSE
├── README.md
├── example
│   ├── assets                            // 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',
    'node_modules/@vivliostyle/theme-academic',
    '.'
  ],
  entry: [
      'example/default.md',
      // and more...
  ],
}

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

npm run validate
# or
yarn validate

About

An academic theme for Vivliostyle

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published