{"id":17025524,"url":"https://github.com/dsebastien/presentations-revealjs","last_synced_at":"2025-08-02T20:34:46.356Z","repository":{"id":31047549,"uuid":"34606222","full_name":"dsebastien/presentations-revealjs","owner":"dsebastien","description":"This is a simple to use template for creating Reveal.js presentations using Markdown alone that comes along with a useful build script.","archived":false,"fork":false,"pushed_at":"2018-06-02T17:12:02.000Z","size":430,"stargazers_count":6,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-12T11:40:43.687Z","etag":null,"topics":["presentation","presentation-slides","reveal-js","revealjs","slide-deck","slides"],"latest_commit_sha":null,"homepage":"http://www.dsebastien.net/2015/04/26/reveal-js-me-something/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"MvvmCross/MvvmCross","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dsebastien.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.MD","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-26T09:53:03.000Z","updated_at":"2024-11-14T12:55:34.000Z","dependencies_parsed_at":"2022-09-08T18:21:04.565Z","dependency_job_id":null,"html_url":"https://github.com/dsebastien/presentations-revealjs","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/dsebastien/presentations-revealjs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsebastien%2Fpresentations-revealjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsebastien%2Fpresentations-revealjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsebastien%2Fpresentations-revealjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsebastien%2Fpresentations-revealjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dsebastien","download_url":"https://codeload.github.com/dsebastien/presentations-revealjs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsebastien%2Fpresentations-revealjs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268448362,"owners_count":24252019,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["presentation","presentation-slides","reveal-js","revealjs","slide-deck","slides"],"created_at":"2024-10-14T07:29:24.510Z","updated_at":"2025-08-02T20:34:46.316Z","avatar_url":"https://github.com/dsebastien.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dSebastien's reveal.js presentations template\n\n## About\n\nThis is a simple to use template for creating [Reveal.js](http://lab.hakim.se/reveal-js/) presentations using Markdown alone that comes along with a useful build script.\n\nUsing it you can:\n* Create your slide deck using markdown alone\n* Edit your metadata in a single configuration file\n* Tweak Reveal.JS as you wish in the provided template\n* Use a few NPM commands to build your presentation and serve it to the world\n* See the results live (thanks to [BrowserSync](http://www.browsersync.io/))\n\n## Status \u0026 roadmap\nCheck out the current [TODO list](TODO.md)\n\n## Usage\n* Clone the repository\n* Run `npm install --no-optional` to download all dependencies\n* Edit the slide deck using markdown: presentation/main.md\n  * you can create additional markdown (md) files and they'll get merged into a single slide deck\n  * additional md files MUST start with --- (slide separator) otherwise the merge operation will not do what you want. The file names will dictate the order in which they're merged (i.e., follow a natural order in your filenames)\n  * note that 'main.md' must exist and is always loaded first. All other files are appended to this one before all the markdown is converted to reveal.js HTML slides\n  * for more details, check the edition section below\n* Run `npm run debug` to quickly launch the presentation based on the Markdown contents using [reveal-md](https://github.com/webpro/reveal-md). \n  * note that the debug mode won't take your metadata and configuration into account.\n  * moreover, the debug mode doesn't support multiple markdown files, it'll only take the main.md one into account\n* Run `npm run build` to convert your presentation to HTML\n* Run `npm run serve` to watch your presentation for changes, automatically convert to HTML and display the results in your browser\n* Run `npm run clean` to clean all output directories\n* Run `npm run help` to list all available commands\n\n## Options and customization\nYou can customize the options and metadata (e.g., deck title, author, description, theme, ...) by editing the 'presentation/config.json' file.\n\nIf you need, you can add additional entries to the configuration file and refer to these using {{key}} (without whitespace inside) in your slide deck. The placeholders will all get resolved during the build. This is useful in case you reuse code/contents across slides in your deck.\n\nNote that all entries having a key ending with '_comment' in the config file just serve as comments given that comments aren't supported in JSON :)\n\nYou can also adapt the template file and refer to custom placeholders within.\n\nFinally, if you wish to customize the template or the options of Reveal.js, then you can edit the 'presentation/template.html' file. Reference for Reveal.js options: https://github.com/hakimel/reveal.js#configuration\nBy customizing the template, nothing prevents you from adding slides using HTML; this is useful when you want to benefit from all Reveal.js's capabilities.\n\n## Edition\nReveal.JS supports 'Common' Markdown, so just google Markdown to see what you can do :)\nThere are only three Reveal.JS specific things that you should know/use:\n* use --- to mark the separation between slides (only needed before a slide, thus no need to put one at the end of the file\n* use ---- to state that the next slide should be placed below the current one\n* use note: to add speaker notes (don't ask me how these work, I don't use them)\n\nNote that Reveal.js's [fragments](https://github.com/hakimel/reveal.js#fragments) are also supported with Markdown:\n* https://github.com/hakimel/reveal.js#element-attributes\n* https://github.com/hakimel/reveal.js#slide-attributes\n\n## Dependencies\n* reveal.js: the reveal.js library\n* reveal-md: launch a Reveal.js presentation from a markdown file: https://www.npmjs.com/package/reveal-md\n* browser-sync: live page reload \u0026 browser syncing: https://www.npmjs.com/package/browser-sync\n* gulp-replace: string replace plugin for gulp: https://www.npmjs.com/package/gulp-replace\n* gulp-if: conditionally run a task: https://www.npmjs.com/package/gulp-if\n* gulp-change: modify file contents: https://www.npmjs.com/package/gulp-change\n* gulp-debug: useful to verify the stream contents: https://www.npmjs.com/package/gulp-debug\n* gulp-concat: concatenate files: https://www.npmjs.com/package/gulp-concat\n* gulp-jsonlint: validate JSON: https://www.npmjs.com/package/gulp-jsonlint\n* gulp-rename: rename files: https://www.npmjs.com/package/gulp-rename\n* gulp-npm-files: list package.json dependencies so that we can process them (e.g., copy them to the dist folder): https://www.npmjs.com/package/gulp-npm-files\n* gulp-changed: only pass through changed files: https://www.npmjs.com/package/gulp-changed\n* gulp-filter: filter vynil files in a stream: https://www.npmjs.com/package/gulp-filter\n\n## Authors\n### Sebastien Dubois\n* [@Blog](http://www.dsebastien.net)\n* [@Twitter](http://twitter.com/dSebastien)\n* [@GitHub](http://github.com/dSebastien)\n\n## License\nThis project and all associated source code is licensed under the terms of the [MIT License](http://en.wikipedia.org/wiki/MIT_License).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsebastien%2Fpresentations-revealjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdsebastien%2Fpresentations-revealjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsebastien%2Fpresentations-revealjs/lists"}