Skip to content

Latest commit

 

History

History
90 lines (63 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

90 lines (63 loc) · 3.33 KB
Raw

Contributing

First-time setup

git clone [email protected]:MediaComem/comem-archidep.git
cd comem-archidep
npm install

You will also have to re-run npm install when someones adds or updates a dependency.

Usage

All the following commands should be run from the project's directory.

Run slides server

npm start

This will serve the compiled slides (with live-reload) at http://localhost:3000.

Generate slides and deploy to GitHub pages

npm run deploy

This will compile the slides and commit them to a separate repository that is published on GitHub Pages at https://mediacomem.github.io/comem-archidep/.

Warning: this runs a script which requires a Unix shell (use Git Bash or equivalent on Windows).

Create a new subject

  • Create a new directory under subjects, e.g. subjects/space-time-continuum
  • Copy the subject template at templates/README.md into the new directory and edit as needed
  • Create a subjects/space-time-continuum/images directory if you need images

Update tables of contents

npm run doctoc

This will update the tables of contents in all Markdown files using doctoc.

Documentation

To edit the slides, you should be familiar with:

Configuration

The following environment variables can be used for customization:

  • $BROWSER - The browser with which to open the slides when running the slides server (defaults to your system's browser)
  • $BUILD_DIR - The directory in which the generated HTML slides are saved (defaults to build)
  • $LIVERELOAD_PORT - The port on which the live-reload server is run (defaults to 35729)
  • $PDF_BUILD_DIR - The directory in which the generated PDF slides are saved (defaults to pdf)
  • $PORT - The port on which the slides server is run (defaults to 3000)
  • $SOURCE_VERSION - The branch/commit to which source links to GitHub (in the top-right corner of slides) will point to (defaults to the current branch, or the latest commit when using npm run deploy)
  • $WEB_URL - The URL to which the home link (in the top-right corner of slides) will point to (defaults to https://mediacomem.github.io/comem-archidep/)