Built from makenew/deck-bespoke.js.
Superconducting phases of monolayer transition-metal dichalcogenides. Contributed Talk, 2016 APS March Meeting.
$ git clone https://github.com/evansosenko/deck-tmdsc.git
$ cd deck-tmdsc
$ npm install
$ npm start
The deck-tmdsc source is hosted on GitHub. Clone the project with
$ git clone https://github.com/evansosenko/deck-tmdsc.git
You will need Node.js with npm.
Install the development dependencies with
$ npm install
Requirements are version-locked to ensure consistent deploys.
To use the newest allowed Node packages,
or after updating any package versions in package.json,
update and stage npm-shrinkwrap.json with
$ npm update
$ npm shrinkwrap --dev
$ git add npm-shrinkwrap.json
Primary development tasks are defined under scripts in package.json
and available via npm run-script.
View them with
$ npm run
Lint, test, generate, and optimize the production build to public with
$ npm run dist
Build and deploy to GitHub Pages with
$ npm run deploy
The following environment variables can be set to customize the deploy:
DEPLOY_REPO, DEPLOY_BRANCH, DEPLOY_NAME, and DEPLOY_EMAIL.
Create a new wercker SSH key with the name DEPLOY,
add it to a new wercker deploy step,
and add it to the GitHub repository as a deploy key with write access.
Brunch is responsible for the development cycle and the production build.
Start a local Brunch development server with
$ npm start
If installed globally, brunch may be invoked directly.
View available commands with
$ brunch
Linting, deployment, and optimization is handled by gulp.
In a separate window, use gulp to watch for changes and lint HTML, JavaScript, and Sass files with
$ npm run watch
If installed globally, gulp may be invoked directly.
View available commands with
$ gulp --tasks
The Bespoke.js GitHub page covers how to make a deck.
Put slides in app/partials/slides.static.hbs, e.g.,
<section>Slide 1</section>
<section>Slide 2</section>
<section>Slide 3</section>- Install plugins, themes, and any other front end dependencies,
e.g., JavaScript modules, Sass libraries, fonts, etc.,
with
npm i --save. - Use JavaScript modules directly with
import. - Bespoke.js is configured in
app/modules/deck.js. - The
node_modulesdirectory exists in the Sass include path via the setting inbrunch-config.coffee. - Use
app/styles/main.scssas the entry point for your styles. - All other assets may be placed under
app/assets. - Wrap asset paths referenced in your markup
with
DIGESTfor cache busting support.
Meta data is defined in app/index.static.hbs.
- Nil values are indicated by a
~. Nil fields never generate a meta tag. Fields which are Nil by default are generally optional. - The
image,audio, andvideofields must be given as a fully qualified url. The recommended way to specify this value is withDIGEST, e.g., assumingapp/assets/images/logo.pngexists, useimage: DIGEST(/images/logo.png). - Instead of the
videofield, you may specify ayoutubevideo id. - The
twitterfields are used for Twitter Cards, but you must enable them for your domain with Twitter first.
Please submit and comment on bug reports and feature requests.
To submit a patch:
- Fork it (https://github.com/evansosenko/deck-tmdsc/fork).
- Create your feature branch (
git checkout -b my-new-feature). - Make changes.
- Commit your changes (
git commit -am 'Add some feature'). - Push to the branch (
git push origin my-new-feature). - Create a new Pull Request.
deck-bespoke.js by Evan Sosenko is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License .
Based on a work at https://github.com/evansosenko/deck-tmdsc .
Some content may be licensed under other terms where noted.
This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.