mnarayan / remark-boilerplate

A boilerplate to create presentations using remark, Gulp, Stylus and more.

______                          _     ______       _ _                 _       _       
| ___ \                        | |    | ___ \     (_) |               | |     | |      
| |_/ /___ _ __ ___   __ _ _ __| | __ | |_/ / ___  _| | ___ _ __ _ __ | | __ _| |_ ___ 
|    // _ \ '_ ` _ \ / _` | '__| |/ / | ___ \/ _ \| | |/ _ \ '__| '_ \| |/ _` | __/ _ \
| |\ \  __/ | | | | | (_| | |  |   <  | |_/ / (_) | | |  __/ |  | |_) | | (_| | ||  __/
\_| \_\___|_| |_| |_|\__,_|_|  |_|\_\ \____/ \___/|_|_|\___|_|  | .__/|_|\__,_|\__\___|
                                                                | |                    
                                                                |_|                    

This is a boilerplate to use remark easily with Gulp, Jade and Stylus.

To know more about remark and how to use, read the docs here.

Getting Started

Installation

First of all, install the dependencies to run this boilerplate.

• NodeJS
• GulpJS

# Clone this repository
$ git clone [e-mail]:brenopolanski/remark-boilerplate.git my-presentation
$ cd my-presentation

# install dependencies
$ npm install
# run tasks and serve
$ gulp

With the commands above, you have everything to start.

.
├── build
│   ├── css
│   │   └── main.css
│   ├── index.html
│   └── js
│       ├── main.js
│       └── vendor
│           ├── remark-fallback.js
│           ├── remark-language.js
│           └── remark.min.js
├── gulp
│   ├── index.js
│   ├── paths.js
│   └── tasks
│       ├── browser-sync.js
│       ├── default.js
│       ├── deploy-pages.js
│       ├── imagemin.js
│       ├── jade.js
│       ├── js.js
│       ├── stylus.js
│       └── watch.js
├── gulpfile.js
├── package.json
├── README.md
└── src
    ├── js
    │   ├── main.js
    │   └── vendor
    │       ├── remark-fallback.js
    │       ├── remark-language.js
    │       └── remark.min.js
    ├── slides
    │   ├── slide-1.md
    │   ├── slide-2.md
    │   └── slide-3.md
    ├── styl
    │   ├── main.styl
    │   ├── remark-themes
    │   │   └── default.styl
    │   └── vendor
    │       └── remark.styl
    └── templates
        ├── inc
        │   ├── head.jade
        │   └── scripts.jade
        └── index.jade

How to Use

• Write your slides in src/slides folder in separated files using the Markdown syntax and add them on templates/index.jade.

• If you want to add another scripts and css use the templates/inc/ folder and call them in the templates/index.jade.

• Look for different themes on src/styl/remark-themes and call them on src/styl/main.styl.

• For highlight themes you can see in remark Wiki.

How to use with git and deploy to Github Pages

When you clone this repo, every git information will be downloaded to. So, you have to remove all my git stuff to create yours.

# Inside of your project runs to remove git folder.
rm -Rf .git

Next, initialize your git repository:

# init the repo
git init

Commit all files:

# add all files to commit
git add .
# create a commit
git commit -m "Initial commit"

The first deploy needs to be manual:

# creates a gh-pages branch
git checkout -b gh-pages

# push and track the gh-pages branch
git push --set-upstream origin gh-pages

To do next deploys, you just have to run with gulp:

# will create a .publish folder with build content
# and push to gh-pages branch.
gulp deploy-pages

Tasks

• gulp: Initialize watch for changes and a server (localhost:3000);
• gulp js: Execute js files;
• gulp stylus: Compile stylus files;
• gulp imagemin: Compress image files;
• gulp watch: Call for watch files;
• gulp jade: Compile jade files;
• gulp deploy-pages: Deploy compiled files at build to github on branch gh-pages.

Contributing

If you want to help, please read the Contributing guide.

History

For detailed changelog, see Releases.

License

MIT License © Breno Polanski