This package has been deprecated

Author message:

replaced by pub-theme-shower

pub-theme-shower-ribbon

1.7.4 • Public • Published

pub-theme-shower-ribbon

The shower theme for pub-server makes it easy to create HTML presentations using markdown. Markdown headings can serve to delimit slides.

Edit the markdown in any text editor and use the watch feature of pub-server to auto-update a browser preview the file is saved.

When you are ready to publish, run pub -O to generate a set of html output and other static files.

The screenshot below shows the built-in pub-server editor (which still has a few quirks).

tl;dr

The quickest way to start writing your own presentations using this theme is to clone the pub-sample-deck repo from github.

This will also install pub-server in the same directory.

git clone https://github.com/jldec/pub-sample-deck.git
cd pub-sample-deck
npm install

markdown

2 sample presentations are included in this repo's example folder.

The first source in pub-config has fragmentDelim:'md-headings'. This causes each markdown heading to be treated as the beginning of a new slide (and also serve as the heading for that slide.) The heading at the very top of the file becomes the name of the presentation.

In order to use fragment metadata for slide-specific background images, or to enable the use of additional markdown headings inside slides, separate each slide in the markdowns with a fragment delimiter. Use a name property on the first slide for the presentation name.

---- #fragment-name ----
background-image: /path/to/image.jpg

markdown starts after a blank line

In either case, the second slide is interpreted as a cover slide with a background image, if it starts with an ![](image) link.

A slide with no text will be rendered with shout style (large centered text)

credits

Readme

Keywords

none

Package Sidebar

Install

npm i pub-theme-shower-ribbon

Weekly Downloads

26

Version

1.7.4

License

MIT

Unpacked Size

9.19 kB

Total Files

9

Last publish

Collaborators

  • jldec