{"id":13424056,"url":"https://github.com/arnehilmann/markdeck","last_synced_at":"2025-05-16T11:04:30.536Z","repository":{"id":44849464,"uuid":"110701087","full_name":"arnehilmann/markdeck","owner":"arnehilmann","description":"presentations as code - author cool slide decks, text-only, offline-ready, collaborative","archived":false,"fork":false,"pushed_at":"2023-02-04T02:14:29.000Z","size":50010,"stargazers_count":1255,"open_issues_count":10,"forks_count":37,"subscribers_count":22,"default_branch":"main","last_synced_at":"2025-04-09T06:07:31.152Z","etag":null,"topics":["ascii-art","asciinema","decktape","ditaa","graphviz","markdown","markdown-to-html","mathjax","pandoc","pandoc-filter","plantuml","presentation","revealjs","slide-deck","vega-lite"],"latest_commit_sha":null,"homepage":"https://arnehilmann.github.io/markdeck/","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/arnehilmann.png","metadata":{"files":{"readme":"README-v0.54.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}},"created_at":"2017-11-14T14:31:56.000Z","updated_at":"2025-03-20T10:34:25.000Z","dependencies_parsed_at":"2023-02-06T09:46:05.022Z","dependency_job_id":null,"html_url":"https://github.com/arnehilmann/markdeck","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arnehilmann%2Fmarkdeck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arnehilmann%2Fmarkdeck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arnehilmann%2Fmarkdeck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arnehilmann%2Fmarkdeck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arnehilmann","download_url":"https://codeload.github.com/arnehilmann/markdeck/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254518384,"owners_count":22084374,"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":["ascii-art","asciinema","decktape","ditaa","graphviz","markdown","markdown-to-html","mathjax","pandoc","pandoc-filter","plantuml","presentation","revealjs","slide-deck","vega-lite"],"created_at":"2024-07-31T00:00:47.619Z","updated_at":"2025-05-16T11:04:25.526Z","avatar_url":"https://github.com/arnehilmann.png","language":"HTML","funding_links":["https://paypal.me/ArneHilmann"],"categories":["CSS","HTML","markdown","Tools","Markdown"],"sub_categories":["WebTools"],"readme":"# markdeck - presentations as code\n\nauthor cool slide decks, text-only, offline-ready, collaborative\n\n![](https://img.shields.io/github/forks/arnehilmann/markdeck.svg)\n![](https://img.shields.io/github/stars/arnehilmann/markdeck.svg)\n![](https://img.shields.io/github/issues/arnehilmann/markdeck.svg)\n![](https://img.shields.io/github/license/arnehilmann/markdeck.svg)\n[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/ArneHilmann)\n\u003c!--\nhttps://img.shields.io/twitter/url/https/github.com/arnehilmann/markdeck.svg?style=social\n--\u003e\n\n## why?\n\n* converts markdown to a clean html5 slide deck\n* cool looking: based on battle-proven web frameworks, like reveal.js\n* no uplink required, neither when authoring, nor presenting:\u003c/br\u003e\n    no awkward moments during presentation (no \"I am still waiting for the Internet, sorry!\")\n* all batteries included: live renderer, pdf output, asciiart-converter\n* text-only, easy syntax: just markdown\n* fast-n-easy to write: bring your own editor!\n* easy to collaborate-n-reuse: text-only, so bring your own VCS\n* eye-candy: supports unicode, emojis, fontawesome, asciiart, math, charts, code highlighting,\n    recorded terminal sessions, ...\n* self-documenting [documentation slides](DOCUMENTATION.md#self-documenting-documentation-slides):\u003c/br\u003e\n    see the slide source and the result, side-by-side\n\nYou can also visit the shiny [landing page](https://arnehilmann.github.io/markdeck/), the\n[revealjs showcase](https://arnehilmann.github.io/markdeck/showcase/), or the\n[impressjs showcase](https://arnehilmann.github.io/markdeck/showcase.impress/).\n\n\n## install markdeck, tl;dr\n\nYou need `bash`, `curl`, and `docker-compose`, then run the following commands:\n```\ncurl -LO https://raw.githubusercontent.com/arnehilmann/markdeck/master/markdeck\nchmod a+x markdeck\n./markdeck pull\n```\n\nThe `markdeck` script can be stored in a folder in `$PATH` so that it\ncan be executed from everywhere in the file system.\n\n\n## documentation\n\n... can be found in [DOCUMENTATION.md](DOCUMENTATION.md)\n\n\n## how to start from scratch\n\nRun the following command to create an empty presentation (if markdeck\nis not stored in `$PATH` prefix the command with `./`):\n\n```\nmarkdeck scaffold\n```\n\nRun the following command to start markdeck:\n\n```\nmarkdeck\n```\n\nOpen the browser at `http://localhost:8080`.\n\n# edit slides.md, add assets/, consult documentation, ...\n\n\n## how does this work\n\n*markdeck* takes ```slide-*.md``` files in markdown format\nand the assets subdir\nand renders a html5 slidedeck, using [pandoc](http://pandoc.org) as converter\nand [reveal.js](http://lab.hakim.se/reveal-js/) as the presenter framework.\n\nsee the\n[side-by-side view](https://arnehilmann.github.io/markdeck/showcase/explain.html),\nto get an idea how markdeck works and looks like, or have a look\nat the [documentation](DOCUMENTATION.md).\n\n\n## based on\n\n[markdown](https://daringfireball.net/projects/markdown/syntax),\n[pandoc](https://pandoc.org/),\n[reveal.js](https://revealjs.com/#/),\n[plantuml](http://wiki.plantuml.net/site/index),\n[ditaamini](http://ditaa.sourceforge.net/),\n[asciitosvg](https://github.com/dhobsd/asciitosvg),\n[graphviz](https://www.graphviz.org/),\n[asciinema](https://asciinema.org/),\n[decktape](https://github.com/astefanutti/decktape),\n[vega-lite](https://vega.github.io/vega-lite/),\n[mathjax-pandoc-filter](https://www.npmjs.com/package/mathjax-pandoc-filter), and\n[font-awesome](https://fontawesome.com/).\n\n\n## known issues\n\n* custom layout hard, but possible\n* pixel-perfect layout nearly impossible\n* see the [todos](TODOS.md)\n\n\n## similar projects\n\n* http://bigsense.github.io/\n* http://slideshow-s9.github.io\n* https://github.com/FormidableLabs/spectacle\n* https://github.com/divshot/markdeck\n* https://github.com/jxnblk/mdx-deck\n* https://github.com/munen/p_slides\n* https://github.com/regebro/hovercraft\n* https://github.com/sinedied/backslide\n* https://gitpitch.com/\n* https://godoc.org/golang.org/x/tools/cmd/present\n* https://www.deckset.com/\n* https://yhatt.github.io/marp/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farnehilmann%2Fmarkdeck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farnehilmann%2Fmarkdeck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farnehilmann%2Fmarkdeck/lists"}