A plugin for docsify
that allows you to write documentation which acts like a slideshow.
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.
If you would like to have the docsify sidebar hidden by default, simply add the class="close"
to your main body
tag in your index.html
.
<body class="close">...</body>
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.
- Responsive two column layout for your markdown pages.
- Reduced margins and spacing to maximize presentation real estate.
- Closed sidebar behavior is fixed on mobile screens.
If you enable docsify-pagination
:
- Navigate between pages with
<-
and->
keys. docsify-pagination
acts as a sticky footer, so it is always visible on screen.