# reveal-md & github-pages ## github-pages + reveal-md = awesome * write your slides in markdown * commit them to github * get them automatically deployed ## get started * just press this nice & friendly green button ![nice & friendly green button](img/1_pressButton.png) ## get started * give your new repo a name * keep it public! (or git will deny to publish it) ## get started * choose 'gh-pages' to be the public-branch ![settings](img/2_settings.png) ## get started * choose 'gh-pages' to be the public-branch by: * first switching to master * and then switching back to gh-pages * github-bug? ¯\\_(ツ)_/¯ ![settings](img/3_selectBranch.png) ## writing content * edit the markdown-file `slides.md` * find all configurations on [reveal-md](https://github.com/gaerfield/reveal-md-github-pages) ## Customizations * I changed a whee-bit the defaults ## Customizations - CSS * custom.css has some additional configs (who needs borders around pictures) * just remove the content, if it not suits you * but keep the file, or the build will fail ## Customizations - includes * the presentation is split up into multiple documents * useful for large presentations * an include is defined by `{{path/to/include.md}}` ## Customizations - plantuml * I really like diagrams ```` ``` puml A -> B ``` ```` will become
## Customizations - plantuml * check [plantuml](https://plantuml.com/) for more details * or even better: [the hitchhikers guide to plantuml](https://crashedmind.github.io/PlantUMLHitchhikersGuide/) ## Customizations * included scripts are configured in includes.js * clear the content, if customizations not needed (but keep the file!) * never read the following files: * `scripts/fileInclude.js` * `scripts/pumlpreprocessor.js` * I know, they are open-source, but they are also crappy * Me not good is in javascript # The End have fun ;)