{"id":13475883,"url":"https://github.com/a-nau/markdownslides","last_synced_at":"2025-10-05T07:27:13.505Z","repository":{"id":38204451,"uuid":"369144109","full_name":"a-nau/markdownslides","owner":"a-nau","description":"A \"markdown-first\" approach for generating beautiful browser-based slides easily. Based on Reveal.js and Reveal-Jekyll.","archived":false,"fork":false,"pushed_at":"2023-10-10T10:45:33.000Z","size":1093,"stargazers_count":48,"open_issues_count":0,"forks_count":35,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-01T16:40:42.358Z","etag":null,"topics":["github-pages","jekyll","markdown","revealjs","slides"],"latest_commit_sha":null,"homepage":"https://a-nau.github.io/markdownslides","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/a-nau.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-20T08:56:17.000Z","updated_at":"2024-03-03T07:49:23.000Z","dependencies_parsed_at":"2024-10-30T07:31:43.831Z","dependency_job_id":null,"html_url":"https://github.com/a-nau/markdownslides","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-nau%2Fmarkdownslides","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-nau%2Fmarkdownslides/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-nau%2Fmarkdownslides/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-nau%2Fmarkdownslides/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/a-nau","download_url":"https://codeload.github.com/a-nau/markdownslides/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245764582,"owners_count":20668445,"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","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":["github-pages","jekyll","markdown","revealjs","slides"],"created_at":"2024-07-31T16:01:24.409Z","updated_at":"2025-10-05T07:27:08.459Z","avatar_url":"https://github.com/a-nau.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# Markdown Slides\n\n## What is it?\n\nA template project for a Github page\n\n- to quickly create beautiful slides\n- and share them on freely hosted Github pages\n- it is based primarily on Markdown \u0026rarr; easy collaboration and version control\n- you can host multiple presentations\n- to see its full power, just check the [getting started](https://a-nau.github.io/markdownslides/getting_started) presentation\n\nIt is powered by [reveal.js](https://revealjs.com/), an awesome project by [Hakim El Hattab](https://twitter.com/hakimel) and based on and inspired by [reveal-jekyll](https://github.com/tasmo/reveal-jekyll) by [Thomas Friese](https://twitter.com/_tasmo)\n\n## How to set up and use it?\n\nCheck out the [introduction](https://a-nau.github.io/markdownslides/getting_started#/02_intro) slides to see how to use this repo!\n\nYou can set up the project both locally and hosted on Github Pages.\n\n### Github Pages\n\nJust fork the project, and [rename](https://docs.github.com/en/github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch) your main branch to `gh-pages`.\n\nThat's it :)\n\n### Locally\n\nClone the project including submodules using\n\n```bash\ngit clone --recursive https://github.com/a-nau/markdownslides.git\n```\n\nThe you can either [install Jekyll](https://jekyllrb.com/docs/installation/) and [run](https://jekyllrb.com/docs/usage/) it or use the provided Docker image.\n\nWe recommend using the Docker image by following these steps:\n\n- [Install Docker](https://docs.docker.com/get-docker/) if you haven't already\n- Build the Docker image using `docker build -t jekyll .`\n- Run markdownslides with `docker run -v ${PWD}:/app -p 4000:4000 -it --rm --name markdownslides jekyll`\n- Reach the website under [http://localhost:4000/markdownslides/](http://localhost:4000/markdownslides/)\n\nFor more information, also check out this [blog post](https://alcher.dev/2020/jekyll-on-docker/).\n\n## What can it do?\n\nCheck the [examples](https://a-nau.github.io/markdownslides/getting_started#/03_examples)!\n\n---\n\n## Licenses\n\n- [Jekyll](//github.com/jekyll/jekyll): [MIT licensed](//github.com/jekyll/jekyll/blob/master/LICENSE)\n- [reveal.js](//github.com/hakimel/reveal.js): [MIT licensed](//github.com/hakimel/assets/reveal.js/blob/master/LICENSE), Copyright (C) 2016 Hakim El Hattab, http://hakim.se\n- [reveal-jekyll](//github.com/tasmo/reveal-jekyll): [MIT licensed](//github.com/tasmo/reveal-jekyll/blob/master/LICENSE), Copyright (C) 2016 Thomas Friese, http://tasmo.rocks\n- [Github CSS Ribbon](https://github.com/simonwhitaker/github-fork-ribbon-css): [MIT licensed](https://github.com/simonwhitaker/github-fork-ribbon-css/blob/gh-pages/LICENSE), Copyright (c) 2013 Simon Whitaker\n\nEasy Markdown Slides: [MIT licensed](./LICENSE), Copyright (C) 2021 Alexander Naumann, https://a-nau.github.io\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-nau%2Fmarkdownslides","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fa-nau%2Fmarkdownslides","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-nau%2Fmarkdownslides/lists"}