Skip to content

shawntabrizi/docsify-slides

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

docsify-slides

A plugin for docsify that allows you to write documentation which acts like a slideshow.

Install

Simply include the plugin with your docsify project:

<script src="//unpkg.com/docsify-slides/dist/docsify-slides.min.js"></script>

NOTE: This plugin works best in combination with docsify-pagination plugin. Be sure to also enable this plugin on your docsify site for the full experience.

What is it?

This is a simple plugin which gives you a flexible two-column layout via a custom markdown syntax.

Just add:

<!-- slide:break -->

or

<!-- slide:break-# -->

where # is the percent of the total width you want the left side of the slide to be. (i.e. <!-- slide:break-60 -->)

Check out the example.

Features

  1. Responsive two column layout for your markdown pages.
  2. Reduced margins and spacing to maximize presentation real estate.
  3. docsify sidebar is closed by default, and closed sidebar behavior is fixed on mobile screens.

If you enable docsify-pagination:

  1. Navigate between pages with <- and -> keys.
  2. docsify-pagination acts as a sticky footer, so it is always visible on screen.