rrwen / phd-prelim-research

Preliminary PhD research

phd-prelim-research

Richard Wen
[e-mail]

• Slides
• PDF

Preliminary PhD research.

Install

1. Install npm
2. Clone this repository
3. Install dependencies with npm

git clone https://github.com/rrwen/phd-prelim-research
cd phd-prelim-research
npm install

See Edits and Implementation for more details.

Usage

1. Generate docs/index.html (see script.html in package.json)
2. Generate slides/wen2018_phd_prelim_research_slides.pdf (see script.pdf in package.json)

npm run html
npm run pdf

Developer Notes

Edits

The following can be edited before generating:

• slides/wen2018_phd_prelim_research_slides.md: Markdown file with slide contents
• slides/template.html: Custom reveal-md template to generate slides with
• docs/edit/style.css: CSS file to adjust styling of slides
• docs/edit/logo.png: logo image to use

Implementation

The slides phd-prelim-research uses the following npm packages for its implementation:

npm	Purpose
reveal-md	Converting slides/wen2018_phd_prelim_research_slides.md to docs/index.html
decktape	Converting slides/wen2018_phd_prelim_research_slides.md to slides/wen2018_phd_prelim_research_slides.pdf
windows-build-tools	Compiling dependencies for decktape on Windows Operating System (OS)

       reveal-md            <-- Convert markdown  slides to html

       decktape             <-- Convert markdown slides to pdf
          |
  windows-build-tools       <-- Compile decktape on Windows OS