https://github.com/shawntabrizi/docsify-slides

A docsify plugin for creating slideshow-like pages.
https://github.com/shawntabrizi/docsify-slides

Last synced: 4 days ago
JSON representation

A docsify plugin for creating slideshow-like pages.

• Host: GitHub
• URL: https://github.com/shawntabrizi/docsify-slides
• Owner: shawntabrizi
• License: mit
• Created: 2020-02-02T23:41:28.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-11-26T02:09:34.000Z (12 months ago)
• Last Synced: 2024-10-13T01:13:27.219Z (about 1 month ago)
• Language: JavaScript
• Homepage: https://shawntabrizi.github.io/docsify-slides
• Size: 722 KB
• Stars: 24
• Watchers: 3
• Forks: 12
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docsify-slides

A plugin for [`docsify`](https://docsify.js.org/) that allows you to write documentation which acts like a slideshow.

## Install

Simply include the plugin with your `docsify` project:

```html

```

> **NOTE:** This plugin works best in combination with [`docsify-pagination`](https://github.com/imyelo/docsify-pagination) plugin.

> Be sure to also enable this plugin on your docsify site for the full experience.

### Default Closed Sidebar

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`.

```html

...

```

## What is it?

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

Just add:

```html

```

or

```html

```

where `#` is the percent of the total width you want the left side of the slide to be. (i.e. ``)

Check out the [example](https://shawntabrizi.github.io/docsify-slides).

### Features

1. Responsive two column layout for your markdown pages.

2. Reduced margins and spacing to maximize presentation real estate.

3. Closed sidebar behavior is [fixed on mobile screens](https://github.com/docsifyjs/docsify/issues/442).

If you enable [`docsify-pagination`](https://github.com/imyelo/docsify-pagination):

4. Navigate between pages with `<-` and `->` keys.

5. [`docsify-pagination`](https://github.com/imyelo/docsify-pagination) acts as a sticky footer, so it is always visible on screen.