Skip to content

Latest commit

 

History

History
245 lines (179 loc) · 5.84 KB

README.md

File metadata and controls

245 lines (179 loc) · 5.84 KB
Raw
📝 easily make slides with markdown

npm Travis AppVeyor Codecov

Just write the markdown and make the cool slide.

Demos

Install

Node versions > v8

$ npm i fusuma --save-dev # or npm i fusuma -g

# if you want to use yarn
$ yarn add fusuma --dev

Procedure

Just execute the following three lines for executing, generating and deploying slides!

$ npm i fusuma -D
$ npx fusuma init
$ mkdir slides && echo '# Hello😄' > slides/title.md

# --- Tree ---
$ tree -a
.
├── .fusumarc.yml
└── slides
    └── title.md

1 directory, 2 files

# --- executable tasks---
$ npx fusuma start    # development
$ npx fusuma build    # build as NODE_ENV=production
$ npx fusuma deploy   # deploy to github pages
$ npx fusuma pdf      # export as PDF from HTML

When npx fusuma start is executed, it is output as follows.

Feature

  • support bespoke.js
  • support Presentation API
  • support animations of page transition and lazy-load
  • support SNS, fullscreen, Presenter Mode
  • support development mode, production build and deploy
  • overwriting of js and css is possible
  • export as PDF

Directory Structure

Please see samples or Verification Repository.

Slide order is numeric, alphabetical.

.
├── .fusumarc.yml       <-- a configuration file
├── index.js            <-- optional for rewriting
├── slides              <-- slides written by Markdown or HTML
│   ├── 0-title.md
│   ├── 01-content.md
│   ├── 02-body
│   │   └── 0-title.md
│   └── 03-end.md
└── style.css           <-- optional for rewriting

2 directories, 7 files

Also, slides can be divided by --- too.

<!-- background: title -->

# Title

---

<!-- background: red -->

## Hi😜

This page is the next page of the title.

Usage

   fusuma.js 0.10.2 - CLI for easily make slides with markdown

   USAGE

     fusuma.js <command> [options]

   COMMANDS

     init                Create a configure file
     start               Start with webpack-dev-server
     build               Build with webpack
     deploy              Deploy to GitHub pages
     pdf                 Export as PDF
     help <command>      Display help for a specific command

   GLOBAL OPTIONS

     -h, --help         Display help
     -V, --version      Display version
     --no-color         Disable colors
     --quiet            Quiet mode - only displays warn and error messages
     -v, --verbose      Verbose mode - will also output debug messages

Configuration File

Support for yaml and js.

.fusumarc.yml

meta:
  url: https://slides.hiroppy.me
  name: the present and future of JavaScript
  author: Yuta Hiroto
  description: Explain how specifications are determined and how it will be in the future.
  thumbnail: https://avatars1.githubusercontent.com/u/1725583?v=4&s=200
  siteName: slides.hiroppy.me
  repositoryUrl: https://github.com/hiroppy/fusuma
  sns:
    - twitter
    - hatena
slide:
  theme: nebula
  sidebar: true
  targetBlank: true
  pageNumber: false
extends:
  js: index.js
  css: style.css

.fusumarc.js

module.exports = {
  meta: {
    url: 'https://slide.hiroppy.me',
    name: 'test-test',
    author: 'hiroppy',
    description: 'test',
    thumbnail: 'url',
    siteName: 'siteName',
    sns: ['twitter', 'hatena'],
    repositoryUrl: 'https://github.com/hiroppy/fusuma'
  },
  slide: {
    theme: 'nebula',
    sidebar: true,
    targetBlank: true,
    pageNumber: false
  },
  extends: {
    js: 'index.js',
    css: 'style.css'
  }
};

Themes

  • Cube
  • Voltaire
  • Nebula (default)

https://github.com/bespokejs/bespoke#themes

Or you can specify a theme.

Slide Syntax

See docs/slide.md.

Presenter Mode

Click the rocket(:rocket:) icon from the bottom right menu(三) and then slides for presentation will be opened as a new window, and an already open window will be windows for presenters.

Host: ?presenter=host
View: ?presenter=view

Library

  • Bespoke
  • Babel
  • webpack
  • Postcss
  • Prism
  • React
  • Workbox

API

const { start, build, deploy, pdf } = require('fusuma');

Articles