Skip to content

Commit 5bc967a

Browse files
committed
Update docs and styles
1 parent 681ce83 commit 5bc967a

File tree

3 files changed

+18
-5
lines changed

3 files changed

+18
-5
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
# docsify-slides
22

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

5-
> **NOTE:** This plugin works best in combintation with [`docsify-pagination`](https://github.com/imyelo/docsify-pagination) plugin.
5+
## Install
6+
7+
Simply include the plugin with your `docsify` project:
8+
9+
```html
10+
<script src="//unpkg.com/docsify-slides/dist/docsify-slides.min.js"></script>
11+
```
12+
13+
> **NOTE:** This plugin works best in combination with [`docsify-pagination`](https://github.com/imyelo/docsify-pagination) plugin.
614
> Be sure to also enable this plugin on your docsify site for the full experience.
715
816
## What is it?
@@ -21,7 +29,9 @@ or
2129
<!-- slide:break-# -->
2230
```
2331

24-
where `#` is the percent of the total width you want the left side of the slide to be.
32+
where `#` is the percent of the total width you want the left side of the slide to be. (i.e. `<!-- slide:break-60 -->`)
33+
34+
Check out the [example](https://shawntabrizi.github.io/docsify-slides).
2535

2636
### Features
2737

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "docsify-slides",
3-
"version": "1.0.3",
3+
"version": "1.0.4",
44
"description": "A docsify plugin for creating slideshow-like pages.",
55
"main": "src",
66
"repository": "https://github.com/shawntabrizi/docsify-slides",

src/stylesheet.css

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@
2525
right: 0;
2626
height: 4em;
2727
background-color: #ffffff;
28-
margin: 0 5em;
28+
padding-left: 40px;
29+
padding-right: 10px;
30+
margin-bottom: 0px;
2931
}
3032
body .pagination-item--previous {
3133
transform: translateX(300px);
@@ -41,6 +43,7 @@
4143
.slide-col {
4244
float: left;
4345
padding: 10px;
46+
padding-bottom: 4em;
4447
}
4548

4649
@media screen and (max-width: 768px) {

0 commit comments

Comments
 (0)