{"id":13869730,"url":"https://github.com/dadoomer/markdown-slides","last_synced_at":"2025-07-15T18:31:52.792Z","repository":{"id":41339373,"uuid":"289606466","full_name":"dadoomer/markdown-slides","owner":"dadoomer","description":"Using markdown, write simple but beautiful presentations with math, animations and media.","archived":false,"fork":false,"pushed_at":"2022-12-15T19:33:40.000Z","size":87261,"stargazers_count":134,"open_issues_count":6,"forks_count":26,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-14T20:52:55.484Z","etag":null,"topics":["markdown","markdown-slides","presentation","presentation-slides","slide-deck","slide-show","slidedeck","slides","slideshow"],"latest_commit_sha":null,"homepage":"https://da_doomer.gitlab.io/markdown-slides/","language":"Python","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/dadoomer.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}},"created_at":"2020-08-23T03:10:43.000Z","updated_at":"2025-06-28T10:48:49.000Z","dependencies_parsed_at":"2023-01-29T04:15:45.647Z","dependency_job_id":null,"html_url":"https://github.com/dadoomer/markdown-slides","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dadoomer/markdown-slides","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dadoomer%2Fmarkdown-slides","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dadoomer%2Fmarkdown-slides/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dadoomer%2Fmarkdown-slides/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dadoomer%2Fmarkdown-slides/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dadoomer","download_url":"https://codeload.github.com/dadoomer/markdown-slides/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dadoomer%2Fmarkdown-slides/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265451443,"owners_count":23767768,"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":["markdown","markdown-slides","presentation","presentation-slides","slide-deck","slide-show","slidedeck","slides","slideshow"],"created_at":"2024-08-05T20:01:14.266Z","updated_at":"2025-07-15T18:31:52.275Z","avatar_url":"https://github.com/dadoomer.png","language":"Python","readme":"![logo](logos/wide.png)\n\n**Using markdown, write simple but beautiful presentations with math,\nanimations and media, which can be visualized in a web browser or exported to\nPDF.**\n\nSee the official [git repository hosted on Gitlab](https://gitlab.com/da_doomer/markdown-slides) or the [Github mirror](https://github.com/dadoomer/markdown-slides).\n\nThis program appropriately inserts markdown files into Reveal.js files,\ncompletely avoiding the need to edit HTML files directly.\n\n# Live demo\n\n**See for yourself**: check out the [live demo](https://da_doomer.gitlab.io/markdown-slides) (and the source file [`presentation.md`](example/presentation.md)).\n\n![](https://user-images.githubusercontent.com/122831/126127604-45c8d817-560a-4d88-9344-7767777d8a83.gif)\n\n# Installation\n\n```bash\npython -m pip install git+https://gitlab.com/da_doomer/markdown-slides.git\n```\n\nMarkdown-slides works with Python \u003e= 3.8.\n\nDon't have python? Your version of python not working? Scroll down to [fearless, conflict-free Python installation](#fearless-conflict-free-python-installation).\n\n# Usage\n\n```bash\nmdslides [-h] [--include RESOURCE] [--pdf] [--output_dir DIR] FILE\n```\n\nwhere\n\n- `RESOURCE`: any file or directory that should be included (e.g. a directory with pictures and videos)\n\n- `FILE`: input markdown file.\n\n- `DIR`: output directory. Defaults to a new directory in the working directory with the same name as the input file, but without suffix.\n\nNotes:\n\n - PDF exporting requires chromium (see [PDF exporting on\n\t reveal-js](https://revealjs.com/pdf-export/)).\n\n\n## QuickStart Example\n\n1. Install markdown-slides\n\n2. Download the example [presentation.md](https://raw.githubusercontent.com/dadoomer/markdown-slides/master/example/presentation.md) folder\n   ```bash\n    wget \"https://gitlab.com/da_doomer/markdown-slides/-/archive/master/markdown-slides-master.zip?path=example\"; unzip markdown-slides-master.zip\\?path=example; cd markdown-slides-master-example/example;\n   ```\n3. Render the slide deck into a web page, including the `media` folder\n   ```bash\n   mdslides ./presentation.md --include media\n   ```\n4. Open the slides in your browser (or publish to github pages)\n   ```bash\n   open ./presentation/index.html\n   ```\n\n# Syntax:\n\nYou will probably only need to break slides:\n\n```md\n# My title\nA subtitle maybe\n\n[comment]: # (!!!)\n\nSecond slide. Easy :D\n```\n\nOther options are documented in the example presentation [`presentation.md`](example/presentation.md).\n\nIf you need a quick refresher on markdown see e.g.\n[this cheatsheet](https://www.markdownguide.org/cheat-sheet/), the\n[CommonMark reference page](https://commonmark.org/help/), or this\n[Gfm tutorial](https://guides.github.com/features/mastering-markdown/).\n\nYou will not have to break your markdown files to use this program. Control\nReveal.js' theme and options using CommonMark-compliant comments.\n\nEverything but slide-break comments and option comments is passed to Reveal.js verbatim. Check out their documentation, especially the [markdown section](https://revealjs.com/markdown/).\n\n# Features\n\nSome of Reveal.js's features are:\n\n- LaTeX math syntax.\n- Automatic animations.\n- Background videos and images.\n\nKeep in mind you need an Internet connection to render equations (see [issue #9](https://gitlab.com/da_doomer/markdown-slides/-/issues/9)).\n\n# Troubleshooting\n\nIf you encounter any issues or have some questions, open an [issue on Gitlab](https://gitlab.com/da_doomer/markdown-slides/-/issues) or [on Github](https://github.com/dadoomer/markdown-slides/issues).\n\nComments and pull requests are very welcome!\n\n## Fearless, Conflict-free Python installation\n\nMarkdown-slides works with Python 3.9 or newer.\n\nHere's a fearless, conflict-free python install that Just Works™ in bash, zsh, and fish:\n\n1. [Webi](https://webinstall.dev) will install `pyenv` (the python version manager) to `~/.pyenv`, where it won't conflict with your system python, or any projects:\n   ```bash\n   curl -sS https://webinstall.dev/pyenv | bash\n   ```\n2. After installation you'll need to **CLOSE and RE-OPEN** your terminal, or update your `PATH`:\n   ```bash\n   export PATH=~/.pyenv/bin:\"$PATH\"\n   export PATH=~/.pyenv/shims:\"$PATH\"\n   ```\n3. Now you can install Python v3.9.1 (safely in `~/.pyenv`):\n   ```bash\n   # Install v3.9.1, which works with mdslides\n   pyenv install -v 3.9.1\n   ```\n4. When you need to use `mdslides`, use `pyenv` to set your SHELL's python to 3.9.1:\n   (and you can set it right back afterwards)\n   ```bash\n   # Switch to python 3.9.1, conflict free\n   pyenv global 3.9.1\n\n   # Install and use mdslides\n\n   # Switch to your original system python\n   pyenv global system\n   ```\n\n**Bonus**: You can tell `pyenv` to automatically pick Python 3.9.1 whenever you're in your slides folder:\n\n```bash\ncd ./path/to/my/presentations/\npyenv local 3.9.1\n\n# the presentations folder is now set to use python 3.9.1\ncat ./.python-version # 3.9.1\npython --version\nPython 3.9.1\n\ncd -\npython --version\nPython x.x.x\n```\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdadoomer%2Fmarkdown-slides","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdadoomer%2Fmarkdown-slides","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdadoomer%2Fmarkdown-slides/lists"}