1.0.0 • Published 4 years ago

stuffme-theme-basic v1.0.0

Weekly downloads
1
License
ISC
Repository
-
Last release
4 years ago

StuffMe Theme: Basic

This is a basic theme to be used with StuffMe

Install

$ npm i stuffme-theme-basic -g

Usage

# Serve your slides
$ stuff serve -t stuffme-theme-basic

# Create your slide as a standalone file
$ stuff make -t stuffme-theme-basic

Customize your slides

This basic theme provide many CSS classes that you can applied to your slides or elements to customize their layout.

Layout

NOTE: Some classes have effect only in combination with other classes. In such cases, the whole dependency chain is provided. For example, .grid.col-1-2 means that the class .col-1-2 has effect only if it's set on a slide or element with the class .grid

ClassSlideElementDescription
.leftxxAlign the whole content to the left of the slide or of the element.
.center-hxxCenter the whole content horizontally within the slide or the element.
.rightxxAlign the whole content to the right of the slide or of the element.
.topxxAlign the whole content to the top of the slide or of the element.
.center-vxxCenter the whole content vertically within the slide or the element.
.bottomxxAlign the whole content to the bottom of the slide or of the element.
.gridxApply a 2 column layout on a slide where the title (if any) is on top, and the 2 next elements are placed side by side.
.grid.title-leftxPut the title on the left side of the slide (it will be rotated to appear vertical)
.grid.title-rightxPut the title on the right side of the slide (it will be rotated to appear vertical)
.grid.title-bottomxPut the title at the bottom of the slide
.grid.col-1-2xTweak the 2 column layout to have the 2nd column twice the size of the 1st one.
.grid.col-2-1xTweak the 2 column layout to have the 1st column twice the size of the 2nd one.
.grid.col-1-1-1xApply a 3 column layout on a slide where the title (if any) is on top, and the 3 next elements are placed side by side.
.grid.col-1-1-2xTweak the 3 column layout to have the 3rd column twice the size of the other two.
.grid.col-1-2-1xTweak the 3 column layout to have the 2nd column twice the size of the other two.
.grid.col-2-1-1xTweak the 3 column layout to have the 1st column twice the size of the other two.

Font size

Font size modifiers, when they are applied on a slide, change the font size of all children in a way that preserves the relative size difference between each children. However, when applied on elements they force the size regardless of any context.

ClassSlideElementDescription
.font-xxlxxIncrease the font size to the largest size available.
.font-xlxxIncrease the font size to an extra large size.
.font-lxxIncrease the font size to a larger size.
.font-mxxSet the font size to a medium size. This is the default font size applied to the document.
.font-sxxDecrease the font size to a smaller size.
.font-xsxxDecrease the font size to an extra small size.
.font-xxsxxDecrease the font size to the smallest size available.

Special cases

ClassSlideElementDescription
.marginxxAdd an extra bottom margin to elements. This is usually used to mimic a paragraph structure when list are tweaked with the .no-bullet class.
.no-bulletxxRemove the bullets from <ul> and <ol> elements.
.plainxRemove border and background from targeted <img> elements.
.stretchxForce an element to be maximized in size while fitting within the slide. it is usually applied to image, iframe, video or code block.