Skip to content

codeyoma/quartz-slide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Quartz-Slide

  • It’s a custom plugin that enables slide in Quartz 4.
  • demo slide
  • Slides are divided based on Markdown headings (# to ######, corresponding to <h1>–<h6>) or horizontal rules (---, corresponding to <hr>)

Supported Features

  • Runtime Slide
    • Toggle slide - Press cmd / ctrl + s
    • Start slide - Click the slide icon button
  • Footnote Anchors
    • Navigate to the correct slide when clicked
    • Only works when enableSPA: false in quart.config.ts
  • Automatic Index Generation
  • Content Alignment Option
  • URL Parameters Options
    Parameter Type Default Description
    slide boolean false If start=true is set, the slide starts automatically
    ratio string 16:9 Slide aspect ratio 16:9 or 4:3
    scroll boolean false Enable mouse scroll navigation
    touch boolean true Enable touch navigation
    click boolean false Enable click-based navigation
    startOnChange boolean true Auto-start timer on slide change
    resetable boolean true Allow timer reset
    enabled boolean true Enable slide timer
    includePresenterNotes boolean true Display presenter notes in the slide view
    tags boolean true Display tags on the cover slide
    index boolean true Displays the Table of Contents for the document on the second slide
    align string left Horizontal alignment of slide content left or center
  • Keyboard shortcuts
    • All of these shortcuts can also be seen during a presentation by pressing H or ?
    • h or ? : Toggle the help window
    • j : Jump to next slide
    • k : Jump to previous slide
    • b : Toggle blackout mode
    • m : Toggle mirrored mode.
    • c : Create a clone presentation on a new window
    • p : Toggle PresenterMode
    • f : Toggle Fullscreen
    • t : Reset presentation timer
    • <number> + <Return> : Jump to slide <number>
  • Presenter Notes
    • To add presenter notes to a slide, insert a line with three question marks (???) between the slide content and the notes.
      • Everything before ??? will appear on the slide.
      • Everything after ??? will be shown only as presenter notes.
    • # Header
      Slide content
      ???
      Presenter Notes
      

Installation

  • You must complete all of the following steps for it to work.

1. Add files

  • Slide.tsx -> quartz/components/Slide.tsx
  • slide.inline.ts -> quartz/components/scripts/slide.inline.ts
  • slide.js -> quartz/static/scripts/slide.js
  • slide.scss -> quartz/components/styles/slide.scss
  • slide-custom.scss -> quartz/styles/custom.scss
    • Instead of replacing or moving the file, the contents must be pasted into custom.scss

2. Edit quartz/components/index.ts

import Slide from './Slide'

export{
  ...,
  Slide
}

3. Edit quartz/components/scripts/popover.inline.ts

  • Add this at the end of the file
export { mouseEnterHandler, clearActivePopover }

4. Edit quartz.layout.ts

export const defaultContentPageLayout: PageLayout = {
// or export const defaultListPageLayout: PageLayout = {
  left: [
    Component.Flex({
      components: [
        ...,
        { Component: Component.Slide() }
      ]
    })
  ]

}

Options

Component.Slide({
  ratio: "16:9" | "4:3",          // default 16:9
  navigation: {
    scroll: boolean,              // default false
    touch: boolean,               // default true
    click: boolean,               // default false
  },
  timer: {
    startOnChange: boolean,       // default true
    resetable: boolean,           // default true
    enabled: boolean,             // default true
  },
  includePresenterNotes: boolean, // default true
  tags: boolean,                  // default true
  index: boolean,                 // default true
  align: "left" | "center"        // default left
}),

Done!

  • Enjoy the Slide!

About

custom plugin that enables slide in Quartz 4

Topics

Resources

License

Stars

Watchers

Forks