Skip to content

Commit

Permalink
Merge pull request #24 from mrmanc/use-docker-compose
Browse files Browse the repository at this point in the history
Add ability to run `docker-compose up` to preview changes locally
  • Loading branch information
dploeger authored Feb 5, 2019
2 parents de0e5ea + d070e61 commit 42ad14b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A Jekyll-based framework for creating presentations based on Reveal.js and Markd

If you like [Reveal.js][] for creating your online presentations, like the site management [Jekyll][] gives you and like [Markdown][] because of its easy and clean look, here's an easy way to create a presentation using Jekyll, Markdown and Reveal.js.

See the [example presentation][] created using the contents in this repository and `jekyll build`.
See the [example presentation][] created using the contents in this repository and `jekyll build` or `docker-compose up`.

## Howto

Expand All @@ -37,6 +37,10 @@ After that, add your slides into the `_posts` subdirectory in clean Markdown syn

jekyll build

If you don’t have Jekyll installed (but you do have Docker) then you can just run the following to build and serve your changes using a container. Hit `ctrl-c` to stop the process.

docker-compose up

You can even manage multiple presentations using the power of Git. Simply branch from the master branch to create a new presentation:

git checkout master
Expand Down
8 changes: 8 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
version: "3"
services:
github-pages:
volumes:
- '$PWD:/usr/src/app/'
ports:
- '4000:4000'
image: starefossen/github-pages

0 comments on commit 42ad14b

Please sign in to comment.