{"id":13477536,"url":"https://github.com/jceb/mdshow","last_synced_at":"2025-04-17T12:43:40.870Z","repository":{"id":51325318,"uuid":"272024411","full_name":"jceb/mdshow","owner":"jceb","description":"Turn markdown files into beautiful presentations quickly","archived":false,"fork":false,"pushed_at":"2023-02-02T14:14:02.000Z","size":17329,"stargazers_count":42,"open_issues_count":2,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-22T21:02:20.915Z","etag":null,"topics":["fontawesome","markdown","markup","pandoc","presentations","revealjs","slides","slideshow"],"latest_commit_sha":null,"homepage":"https://mdshow.e-jc.de/","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jceb.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-06-13T14:27:40.000Z","updated_at":"2024-11-28T22:55:18.000Z","dependencies_parsed_at":"2023-02-17T20:46:05.058Z","dependency_job_id":null,"html_url":"https://github.com/jceb/mdshow","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jceb%2Fmdshow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jceb%2Fmdshow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jceb%2Fmdshow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jceb%2Fmdshow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jceb","download_url":"https://codeload.github.com/jceb/mdshow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249342163,"owners_count":21254235,"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":["fontawesome","markdown","markup","pandoc","presentations","revealjs","slides","slideshow"],"created_at":"2024-07-31T16:01:44.163Z","updated_at":"2025-04-17T12:43:40.850Z","avatar_url":"https://github.com/jceb.png","language":"Makefile","funding_links":[],"categories":["Makefile"],"sub_categories":[],"readme":"# WARNING: This project is discontinued.\n\nA replacement has been started with https://github.com/jceb/slidesdown.\n\n# `mdshow`\n\n\u003e Turn markdown files into beautiful presentations quickly.\n\n`mdshow` is built to quickly turn ideas into beautiful presentations.\n\nThe tool of choice for capturing ideas is the text-based\n[Markdown](https://daringfireball.net/projects/markdown/) format. The\nheavy lifting of making text beautiful is left to\n[reveal.js](https://revealjs.com/), a popular web presentation framework.\n`mdshow` does the work in between of turning text into a presentation.\n\n[![](assets/screenshot400.png)](https://youtu.be/ZNXvQGsk_wA)\n\n- [Introduction video to mdshow](https://youtu.be/ZNXvQGsk_wA)\n- [Example HTML presentation](https://mdshow.e-jc.de/)\n- [Example PDF](./examples/slides.pdf)\n- [Example Markdown](https://raw.githubusercontent.com/jceb/mdshow/master/examples/slides.md)\n\n## Table of Contents\n\n- [Features](#features)\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n- [Maintainers](#maintainers)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n\n- Built with [reveal.js 4.0](https://revealjs.com/) and [pandoc\n  2.9](https://pandoc.org/)\n\n### Focus\n\n- Minimally invasive. All data is kept in `slides.md`, `assets/`, and a\n  temporary `.build/` folder\n- Markdown as the sole markup to focus on\n\n### Enterprise\n\n- Custom themes and reuse of themes across all presentations\n- Default settings across all presentations\n- Custom settings per presentation\n- Live-reload of changes\n- PDF conversion\n\n### Setup\n\n- Scaffolding for a quick start (run `mdshow scaffold` to create )\n- Auto-generated title slide\n- Usable default settings\n\n### Presentation\n\n- [Font Awesome](https://fontawesome.com/) integration\n- [chart.js](https://www.chartjs.org) integration\n- Multiple columns per slide\n- Syntax highlighting for source code\n- Incremental display of bullet points and other fragments\n- Zoom into slide (press `\u003cAlt-Left Mouse Button\u003e` or `\u003cCtrl-Left Mouse\n  Button\u003e` to zoom)\n- Separate speaker notes view (press `\u003cs\u003e` to show)\n- Slide overview and navigation (press `\u003cEsc\u003e` to enter overview and\n  `\u003cEsc\u003e` to show selected slide)\n\n## Background\n\nI've been using various markup formats like org-mode, asciidoc and\nmarkdown extensively and for professional purposes, e.g. writing a\nthesis, publishing documentation or keeping notes. However, for\npresentations I usually revert back to MS PowerPoint and Libreoffice\nImpress although web browsers are obviously way better at presenting\ncontent!\n\nWhile PowerPoint \u0026 Co. get the job done, plain text is so much faster\nand more usable to me. For example, I can keep it in a repository to\ntrack revisions + use all the git infrastructure that exists around\nsharing content.\n\nWhile plain text is faster, I had a hard time finding tools that would\nmake it easy for me to concentrate on creating content. Furthermore, the\n*speed* of tools is very important to me. On the side of functionality I\nvalue *theming*, esp. across multiple presentations as well as *no\nclutter* in my presentation directory.\n\nI took lots of inspiration from\n[markdeck](https://github.com/arnehilmann/markdeck) that I've been using\nsuccessfully for a few years. I like the full-featured approach of\nmarkdeck and aim to bring many of its features to `mdshow` following an\nopinionated path.\n\n## Install\n\n### Prerequisites\n\n- `autoconf`\n- `automake`\n- `curl`\n- `g++`\n- `gcc`\n- `make`\n- `pandoc`, suggest version 2.9.x\n- `unzip`\n\n### Installation\n\nDownload the program:\n\n```\ncurl -LO https://raw.githubusercontent.com/jceb/mdshow/master/mdshow\n```\n\nCopy the `mdshow` program to a directory in `$PATH` and make it\nexecutable:\n\n```\nchmod a+x mdshow\n```\n\nTest and download dependencies:\n\n```\nmdshow setup\n```\n\n## Usage\n\nCreate a new presentation in a new directory:\n\n```\nmdshow scaffold\n```\n\nThe command will create a `slides.md` file and an `assets` directory.\nPlace all assets like pictures in the `assets` directory. The content of\nthe presentation lives in `slides.md`.\n\nDisplay the presentation in a [browser](http://localhost:3000) with\nlive-reload:\n\n```\nmdshow serve\n```\n\nIf you want to use a different file name pass it to mdshow via the\n`SLIDES` parameter:\n\n```\nmdshow serve SLIDES=custom.md\n```\n\nConvert the presentation to a PDF file (make sure `mdshow serve` is\nrunning before executing the following command):\n\n```\nmdshow pdf\n```\n\nConvert the presentation to a single, self-contained HTML file (make\nsure `mdshow serve` is running before executing the following command):\n\nATTENTION: this command fails to include images that are added to a\nslide via `data-background-image` attribute.\n\n```\nmdshow html\n```\n\nMore commands and information:\n\n```\nmdshow help\n```\n\n## Maintainers\n\n[@jceb](https://github.com/jceb)\n\n## Contributing\n\nPRs accepted.\n\nSmall note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.\n\n## License\n\nApache-2.0 2020 Jan Christoph Ebersbach\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjceb%2Fmdshow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjceb%2Fmdshow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjceb%2Fmdshow/lists"}