Skip to content
A docsify plugin for creating slideshow-like pages.
JavaScript CSS HTML
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example Make kitties secure Feb 3, 2020
src
.gitattributes Initial commit Feb 2, 2020
.gitignore Publish v1.0 Feb 2, 2020
.nojekyll Create .nojekyll Feb 3, 2020
LICENSE
README.md Update docs and styles Feb 3, 2020
_sidebar.md Update _sidebar.md Feb 3, 2020
index.html Update docsify configuration Feb 3, 2020
package.json
rollup.config.base.js Publish v1.0 Feb 2, 2020
rollup.config.js Publish v1.0 Feb 2, 2020
yarn.lock bump deps Feb 2, 2020

README.md

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.
You can’t perform that action at this time.