{"id":46711745,"url":"https://github.com/slidesdown/slidesdown","last_synced_at":"2026-04-21T09:02:28.112Z","repository":{"id":65742571,"uuid":"591353605","full_name":"slidesdown/slidesdown","owner":"slidesdown","description":"Presentations at the speed of Markdown","archived":false,"fork":false,"pushed_at":"2026-04-20T18:57:13.000Z","size":18350,"stargazers_count":80,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-04-20T20:39:08.845Z","etag":null,"topics":["fast","markdown","presentation","reveal-js","revealjs","slides","slideshow"],"latest_commit_sha":null,"homepage":"https://slidesdown.github.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slidesdown.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-01-20T14:53:40.000Z","updated_at":"2026-04-20T18:57:39.000Z","dependencies_parsed_at":"2023-02-20T17:31:18.670Z","dependency_job_id":"bd5484f9-4c74-4e19-b24f-172c65e0fec2","html_url":"https://github.com/slidesdown/slidesdown","commit_stats":null,"previous_names":[],"tags_count":103,"template":false,"template_full_name":null,"purl":"pkg:github/slidesdown/slidesdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slidesdown%2Fslidesdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slidesdown%2Fslidesdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slidesdown%2Fslidesdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slidesdown%2Fslidesdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slidesdown","download_url":"https://codeload.github.com/slidesdown/slidesdown/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slidesdown%2Fslidesdown/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32084721,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-21T06:27:27.065Z","status":"ssl_error","status_checked_at":"2026-04-21T06:27:21.250Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["fast","markdown","presentation","reveal-js","revealjs","slides","slideshow"],"created_at":"2026-03-09T09:01:10.069Z","updated_at":"2026-04-21T09:02:28.073Z","avatar_url":"https://github.com/slidesdown.png","language":"JavaScript","readme":"# \u003cimg src=\"./public/favicon.svg\" alt=\"logo\" height=\"0.8em\" style=\"height: 0.8em; margin: 0;\" /\u003e Slidesdown\n\nPresentations at the speed of Markdown\n\n[Slidesdown](https://slidesdown.github.io) is powered by the incredible\n[reveal.js presentation framework](https://revealjs.com/).\n\n[![frontpage](./figures/frontpage.png)](https://slidesdown.github.io)\n\n## Learn\n\nVisit [slidesdown.github.io/learn.html](https://slidesdown.github.io/learn.html)\nto get started.\n\n## Usage: View Slides\n\n### Online Viewer\n\nVisit\n[slidesdown.github.io/loader.html](https://slidesdown.github.io/loader.html) and\nenter the URL to your Markdown presentation, e.g.\n`github.com/slidesdown/slidesdown/SLIDES.md`.\n\n### CLI\n\nSlidesdown provides a CLI to quickly open files on your computer in the Online\nViewer or a viewer hosted in a local Docker container that can be used fully\noffline (i.e. perfect for presentations you want to keep private).\n\n#### Installation\n\n```bash\nsudo curl -L https://raw.githubusercontent.com/slidesdown/slidesdown/main/slidesdown -o /usr/local/bin/slidesdown; sudo chmod a+x /usr/local/bin/slidesdown\n```\n\n`slidesdown` CLI has the following dependencies:\n\n- [`nu`](https://nushell.sh) required interpreter for the slidesdown programm.\n- [`docker`](https://www.docker.com/) required for offline presentations and\n  hot-reloading slides while editing.\n\nOptional dependencies if `docker` isn't used:\n\n- [`python3`](https://www.python.org/) required for online presentations via\n  [slidesdown.github.io](https://slidesdown.github.io) if the slideshow file\n  shall be served from the local computer, i.e. useful for creating slides or\n  when the presentation is private and shall not be made accessible publicly via\n  GitHub.\n- [`decktape`](https://github.com/astefanutti/decktape) or `docker` for\n  exporting slideshows as PDF.\n\n#### Update\n\n```bash\nsudo slidesdown -u\n```\n\n#### Open local file in slidesdown Offline Viewer (docker required)\n\nNavigate to any folder with a `SLIDES.md` file, then run this command:\n\n```bash\nslidesdown -d\n```\n\n#### Open local file in slidesdown Online Viewer (python3 required)\n\nAttention: The file with _not_ transmitted to any online service! It will only\nbe served from a local web server to your local browser!\n\nNavigate to any folder with a `SLIDES.md` file, then run this command:\n\n```bash\nslidesdown\n```\n\n#### Export Slides as PDF\n\nThe exporter can also be used via Docker:\n\n```bash\nslidesdown -d -e\n```\n\nIf a local [`decktape`](https://github.com/astefanutti/decktape) installation\nexists, it can also be used like this:\n\n```bash\nslidesdown -e\n```\n\n## Usage: Create Slides\n\n### Simple\n\nCreate a file called `SLIDES.md` and add your content. Once done, publish it\nonline and open the presentation in the [online viewer](#online-viewer) or use\nthe [CLI](#cli) to do so.\n\n### Use Template\n\nThere are multiple options for starting with a template that includes meta data\nand useful configuration options:\n\n1. Download from GitHub:\n\n```bash\ncurl -sflO https://raw.githubusercontent.com/slidesdown/slidesdown/main/examples/SLIDES.md\n```\n\n2. Use [CLI](#cli):\n\n```bash\nslidesdown -t\n```\n\n3. Copy template from here:\n\n```markdown\n---\n# This is a Slidesdown presentation. Learn about Slidesdown at https://slidesdown.github.io\n\n# Metadata about the presentation:\ntitle: Presentation Title\nsubject: My super presentation\nauthor: Your Name\ndate: 2023-01-20\nkeywords: some useful keywords\n\n# Presentation settings:\n# URL to favicon\nfavicon: /favicon.svg\n# Theme, list of supported themes: https://github.com/slidesdown/slidesdown.github.io/tree/main/vendor/reveal.js/dist/theme\ntheme: white\n# Code highlighting theme, list of supported themes: https://github.com/slidesdown/slidesdown.github.io/tree/main/vendor/highlight.js\nhighlight-theme: tokyo-night-dark\n\n# Show progress bar\nprogress: true\n# Show controls\ncontrols: true\n# Center presentation\ncenter: true\n# Create separate pages for fragments\npdfSeparateFragments: false\n# Loop the presentation\nloop: false\n# Controls automatic progression to the next slide\n# - 0:      Auto-sliding only happens if the data-autoslide HTML attribute\n#           is present on the current slide or fragment\n# - 1+:     All slides will progress automatically at the given interval in milliseconds\n# - false:  No auto-sliding, even if data-autoslide is present\nautoSlide: 0\n# Activate the scroll view (disables 3d navigation), see https://revealjs.com/scroll-view/\n# view: scroll\n# Full list of supported settings:\n# - https://revealjs.com/config/\n# - https://github.com/hakimel/reveal.js/blob/master/js/config.js\n# - https://github.com/slidesdown/slidesdown/blob/main/public/plugin/slidesdown.js#L758\n# UnoCSS styling: https://unocss.dev/interactive/ and https://tailwindcss.com/docs\n# Icons: https://icones.js.org and https://unocss.dev/presets/icons\n---\n\n# My first markdown slideshow\n\nAuthor: Your Name\n\n\u003c!-- generated with\n!deno run --allow-read --allow-write https://deno.land/x/remark_format_cli@0.4.0/remark-format.js --maxdepth 2 %\n--\u003e\n\n## Agenda\n\n1. [A horizontal Slide](#a-horizontal-slide)\n2. [More Examples](#more-examples)\n\n## A horizontal Slide\n\n- More icons at\n  [Icônes \u003cdiv class=\"i-fa6-solid-face-smile inline-block m-auto\"\u003e\u003c/div\u003e](https://icones.js.org)\n\nnotes:\n\n- Some\n- speaker\n- notes\n\n### A veritical Slide\n\n- More class styles at [tailwindcss](https://tailwindcss.com/docs) via\n  [UnoCSS](https://unocss.dev/interactive/)\n\n## More Examples\n\nhttps://github.com/slidesdown/slidesdown/blob/main/SLIDES.md\n\n---\n\n\u003ch2\u003eThe End\u003c/h2\u003e\n\nThank you for your time.\n```\n\n### Publish Slides\n\n#### GitHub Repository\n\nUse the [GitHub CLI - `gh`](https://cli.github.com/)\n\n```bash\ngh repo create myslides --public --clone\nslidesdown -t\n# edit slides ...\ngit add SLIDES.md\ngit commit -m \"first slideshow\"\ngit push\n```\n\nNow, open the presentation in the [online viewer](#online-viewer):\n\n```bash\nxdg-open \"https://slidesdown.github.io/?slides=$(gh browse -n)\"\n```\n\n#### GitHub Gist\n\nUse the [GitHub CLI - `gh`](https://cli.github.com/)\n\n```bash\nslidesdown -t\n# edit slides ...\ngh gist create SLIDES.md --public\n```\n\nNow, copy the printed URL into the `URL` variable and open the\n[online viewer](#online-viewer):\n\n```bash\nURL=\"https://gist.github.com/...\"\nxdg-open \"https://slidesdown.github.io/?slides=${URL}\"\n```\n\n## Development\n\n### Required Tools\n\n- [`nu`](https://nushell.sh) interpreter for the slidesdown programm.\n- [`curl`](https://curl.se/) HTTP client\n- [`gh`](https://github.com/cli/cli) GitHub CLI for creating releases\n- [`git-cliff`](https://github.com/orhun/git-cliff) changelog generator\n- [`just`](https://just.systems/) task runner\n- [`node`](https://nodejs.org/) \u003e=24\n\n### Folder Structure and Important Files\n\n- [`published/`](https://github.com/slidesdown/slidesdown.github.io) build\n  target folder served at\n  [https://slidesdown.github.io](https://slidesdown.github.io) and used in the\n  docker image\n- [`examples/`](./examples) contains example presentations\n- [`index.html`](./index.html) is the presentation template that gets loaded\n- [`Justfile`](./Justfile) tasks collection, run `just` to get the list of tasks\n- [`public/`](./public) contains external dependencies (not part of git) and\n  - [`public/loader.html`](./public/loader.html) presentation loader served at\n    [https://slidesdown.github.io/loader.html](https://slidesdown.github.io/loader.html)\n  - [`public/learn.html`](./public/learn.html) tutorial served at\n    [https://slidesdown.github.io/learn.html](https://slidesdown.github.io/learn.html)\n  - [`public/plugin/slidesdown.js`](./public/plugin/slidesdown.js) Markdown\n    converter plugin - this is the core of this project\n- [`slidesdown`](./slidesdown) CLI\n- [`src/`](./src) contains various scripts for docker and the HTML page\n\n### Setup\n\n- Run `yarn` to install all JavaScript depedencies\n\n### Modify Source Code\n\n- Run `just update-all` to (re)download external dependencies to the `public/`\n  folder\n- Run `just dev` to start the `vite` development server plugin when it gets\n  modified\n\n### Build\n\n- Run `just build` to recreate the `docs/` folder\n- Run `just build-docker` to build a new docker image\n\n### Release\n\n- Commit all changes\n- Run `just release` to create a new GitHub release, update\n  [`CHANGELOG.md`](./CHANGELOG.md), and update tag in\n  [`slidesdown`](./slidesdown) script\n\n## References\n\n- [mdshow](https://github.com/jceb/mdshow) is an older attempt of mine to create\n  simple and fast presentations from Markdown files.\n- [reveal.js](https://revealjs.com/) provides the presentation framework that's\n  the basis for slidesdown.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslidesdown%2Fslidesdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslidesdown%2Fslidesdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslidesdown%2Fslidesdown/lists"}