Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fsword/markslide
build your slide by markdown text
https://github.com/fsword/markslide
Last synced: 3 months ago
JSON representation
build your slide by markdown text
- Host: GitHub
- URL: https://github.com/fsword/markslide
- Owner: fsword
- Created: 2012-09-10T06:32:06.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2013-06-08T11:12:54.000Z (about 11 years ago)
- Last Synced: 2024-01-17T07:29:09.037Z (5 months ago)
- Language: Ruby
- Size: 155 KB
- Stars: 5
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Lists
- awesome-github-star - markslide
README
Build your slides by markdown!
------------------------------
## Why markslide
I'm very excited about [deck.js](https://github.com/imakewebthings/deck.js) project. But editing html directly isn't that handy. I tried zen-coding to save some time. Still, it's not intuitive enough. Then markdown came to me. So here's these two lovely things combined.
## Compatible
The code is compatible with ruby 1.9/2.0.
## Usage
* fork this project as your own
* clone your project
```
git clone git://github.com/fsword/markslide.git
cd markslide
git submodule update --init --recursive
bundle install
```
* create your slide named index.md ( on project )
* generate index.html
```
rake generate #will be generated on the project folder
```
* Open it by your favourite browser
## Special Usage
* You can run this command to pkg your slide resource as .zip
```
rake pkg
```
* If you want to modify the content continuously, you may run this command to `guard` the file's modification.
```
guard
```
* Presenter view. Markslide could use two window for both presenter and audience.
open index.html in your browser, it is called 'main view'
press 'q' on the keyboard, then browser will open presenter view
any slide change event of presenter view will be copy to main view
## Markup
* Encode: UTF-8 is the only supported encoding.
* H1, H2 will be surrounded by section which class is slide, such as:
```markdown
# First Head
## Second Head
```
will become
```html
First Head
Second Head
```
* Every content that begin with ':' will be set slide class, such as:
```markdown
* :hello
```
will become
```html
```
* Comment can be show/hide by press 'p'. You can put '!' on the front of code section to indicate comments, such as:
```markdown
`!comment`
```
will become
```html
comment