Name: svalbard-intro
Owner: Fred Hutchinson Cancer Research Center
Description: A presentation for the Svalbard Vault implementation
Created: 2016-12-20 18:37:19.0
Updated: 2016-12-20 18:37:45.0
Pushed: 2017-01-04 00:41:57.0
Homepage: null
Size: 224
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
__ _ ______ _ _ _ _
_ \ | | | ___ \ (_) | | | | |
/ /___ _ __ ___ __ _ _ __| | __ | |_/ / ___ _| | ___ _ __ _ __ | | __ _| |_ ___
// _ \ '_ ` _ \ / _` | '__| |/ / | ___ \/ _ \| | |/ _ \ '__| '_ \| |/ _` | __/ _ \
\ __/ | | | | | (_| | | | < | |_/ / (_) | | | __/ | | |_) | | (_| | || __/
\_\___|_| |_| |_|\__,_|_| |_|\_\ \____/ \___/|_|_|\___|_| | .__/|_|\__,_|\__\___|
| |
|_|
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.
First of all, install the dependencies to run this boilerplate.
one this repository
t clone git@github.com:brenopolanski/remark-boilerplate.git my-presentation
my-presentation
stall dependencies
m install
n tasks and serve
lp
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
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.
When you clone this repo, every git information will be downloaded to. So, you have to remove all my git stuff to create yours.
side of your project runs to remove git folder.
Rf .git
Next, initialize your git repository:
it the repo
init
Commit all files:
d all files to commit
add .
eate a commit
commit -m "Initial commit"
The first deploy needs to be manual:
eates a gh-pages branch
checkout -b gh-pages
sh and track the gh-pages branch
push --set-upstream origin gh-pages
To do next deploys, you just have to run with gulp:
ll create a .publish folder with build content
d push to gh-pages branch.
deploy-pages
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
.If you want to help, please read the Contributing guide.
For detailed changelog, see Releases.
MIT License © Breno Polanski