Skip to content

Latest commit

 

History

History
283 lines (199 loc) · 9.38 KB

README.md

File metadata and controls

283 lines (199 loc) · 9.38 KB
Raw

greenwood-starter-presentation

Greenwood plugin and kick-starter repo for creating and authoring a slide deck from markdown, powered by GreenwoodJS! ♻️

greenwood-starter-presentation

Netlify Status

Installation

There are a couple options available for how you can use this project to kickstart your next presentation.

Greenwood Plugin (recommended)

This project is principally intended to be consumed by a Greenwood project as a "theme pack" plugin installed from npm. The advantage being that as enhancements and improvements are made to the project, you can pull those in just by updating a version number in your package.json.

If you're new to Greenwood, you can learn more about the project or check out the Getting Started guide.

To add this plugin to an existing Greenwood project (where @greenwood/cli has already been installed), please do the following:

  1. Install the plugin as a dev dependency 
    $ npm i greenwood-starter-presentation --save-dev --legacy-peer-deps
  2. Add this and Greenwood's Import Raw plugin to your greenwood.config.js 
    import { greenwoodPluginImportCss } from '@greenwood/plugin-import-raw';
import { greenwoodThemeStarterPresentation } from 'greenwood-starter-presentation';

export default {
  // ...
  
  plugins: [
    greenwoodPluginImportRaw(),
    greenwoodThemeStarterPresentation()
  ]

};
  3. Make sure to add type: "module" to your package.json
  4. Create a markdown file in your src/pages directory called index.md with these contents 
    ---
layout: index
---

You can see an example of this project in use as a Greenwood plugin in this repo. Feel free to clone or fork that or do whatever you want from there as well.

Git (Fork / Clone)

You can also just fork and / or clone this repo from GitHub using git.

  1. Clone the repo 
    # Using SSH (recommended)
$ git clone git@github.com:thescientist13/greenwood-starter-presentation.git

# Using HTTP / GitHub Credentials
$ git clone https://github.com/thescientist13/greenwood-starter-presentation.git
  2. Change into the project directory and install dependencies 
    $ cd greenwood-starter-presentation
$ npm install

Usage

For those unfamiliar, CSS Zen Garden is a site the shares examples of designers and developers using the same HTML, but making completely unique looking layouts using just CSS. The concept of a theme pack is an homage to this philosophy. Just like you would have in Google Slides or Powerpoint, this project provides not only templates and styles to pre-theme and layout all your context, but also a complete UI to develop and present the slides with!

As this repo and plugin are both based on Greenwood, you are able to use all of Greenwood's standard APIs and plugins in your own project too.

Development

To start developing, simply run the start script

$ npm start

This will open a local development server for you at localhost:1984.

You can preview a production build by using the serve script

$ npm run serve

You can preview the final site at localhost:8080.

If you are using Windows, run npm run serve:win

User Interface

When you are running the app, the following controls and behaviors are available:

  • Updating in any content will live reload the browser for you, preserving the focused slide.
  • Scrolling and clicking any slide in the Preview List on the left will make that slide appear in the _Current Slide) view.
  • Clicking the Presenter Mode button will enable Full Screen mode:
    • Navigate left and right using the left and right arrow keys
    • To exit presenter mode, hit the ESC key

Slide Layouts

To organize your slide content, this plugin provides the following layouts that can be specified in a markdown file's frontmatter.

ex.

---
layout: theme-statement
---

Lorum Ipsum all my content....
  1. theme-center-content - All content is positioned in the center both vertically and horizontally.
  2. theme-outline - Centers a list in the middle of the page with a heading tag at the top/
  3. theme-statement - A slide with content positioned in the bottom left hand corner to help emphasize a point.
  4. theme-title - Provides an opening slide to highlight the talk title and author prominently in the center using heading tags.
  5. theme-top-title-image-left - Positions an image in the lower left hand corner with content flowing to the right.
  6. theme-top-title - Positions an <h1> at the top behind a page width banner using --color-tertiary, with any extra content positioned to the right of the page.
  7. page - (the default if no template is specified) - Will just display a slide with the --color-primary variable to the background color.

The supported structure for the above slides looks like this

Center Content

---
layout: theme-center-content
---

# What's the Deal...?

Lorum Ipsum

See pages/slides/3.md for an example.

Outline

---
layout: theme-outline
---

# My Talk Agenda

1. Intro
1. Topic 1
1. Topic 2
1. Topic 3
1. Thank you!

See pages/slides/2.md for an example.

Statement

---
layout: theme-statement
---

Spicy jalapeno bacon ipsum dolor.

See pages/slides/6.md for an example.

Title

---
layout: theme-title
---

# My Talk

## By Your Name

See pages/slides/1.md for an example.

Top Title Image Left

---
layout: theme-top-title-image-left
---

# Thank You!

@twitter_name

![kitten](https://chuckanddons.com/media/wysiwyg/kitten_blog.jpg)

See pages/slides/7.md for an example.

Top Title

---
layout: theme-top-title
---

# Welcome To My Talk

Empty page body with an h1 at the top with `--color-secondary` color behind it as a top bar.

See pages/slides/4.md for an example.

Remember, you can always add your own HTML and <style> tags right into your markdown. Additionally, Greenwood also supports ad-hoc and one off imports of CSS and JS via frontmatter imports for extra customization!

Theming and Design System

The following global variables are provided to you to customize and override using CSS custom properties.

:root {
  --color-primary: #135;
  --color-secondary: #74b238;
  --color-tertiary: #2b85da;
  --color-text-light: #efefef;
  --color-text-dark: #020202;
  --font-family: 'Optima', sans-serif;
  --font-size: 1.5rem;
  --backgroundUrl: url('../assets/background.jpg');
}

:host {
  --color-primary: #135;
  --color-secondary: #74b238;
  --color-tertiary: #2b85da;
  --color-text-light: #efefef;
  --color-text-dark: #020202;
  --font-family: 'Optima', sans-serif;
  --font-size: 1.5rem;
  --backgroundUrl: url('../assets/background.jpg');
}

Support and Upgrades

Known Issues

There a few open items in our issue tracker as we work to an initial 1.0.0 release. It would also be useful to be familiar with Greenwood's Theme Pack FAQ if something isn't working as expected.

Upgrades

To stay up to date with this repo depends on how you initialized your project or repo.

Plugin

If you using the plugin, any upgrades should just be as simple as upgrading the version of this plugin in your package.json using your package manager of choice.

# npm
$ npm install greenwood-starter-presentation

# yarn
$ yarn upgrade greenwood-starter-presentation --latest

Git

If you cloned this repo, then you should just be able to pull

$ git pull origin master

If you forked, make sure to add this repo as an upstream and pull changes in as needed

# use SSH (recommended) or HTTPS depending on your needs
$ git remote add upstream git@github.com:thescientist13/greenwood-starter-presentation.git
$ git fetch upstream master
$ git checkout master
$ git merge upstream/master

⚠️ Note: By using git and this project, be aware that pulling in upstream changes could likely be prone to merge conflicts if you are changing anything other than src/pages.