{"id":16355958,"url":"https://github.com/timobechtel/mdlaunch","last_synced_at":"2026-01-21T02:04:22.221Z","repository":{"id":40837019,"uuid":"260327887","full_name":"TimoBechtel/mdlaunch","owner":"TimoBechtel","description":"Quickly spin up a HTML presentation from any existing markdown file.","archived":false,"fork":false,"pushed_at":"2023-01-06T04:42:40.000Z","size":948,"stargazers_count":2,"open_issues_count":11,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-15T16:17:47.512Z","etag":null,"topics":["generator","markdown","presentation","revealjs","slides","slideshow"],"latest_commit_sha":null,"homepage":"https://timobechtel.github.io/mdlaunch/","language":"JavaScript","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/TimoBechtel.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}},"created_at":"2020-04-30T22:04:46.000Z","updated_at":"2023-03-07T02:39:31.000Z","dependencies_parsed_at":"2023-02-05T08:30:26.135Z","dependency_job_id":null,"html_url":"https://github.com/TimoBechtel/mdlaunch","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimoBechtel%2Fmdlaunch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimoBechtel%2Fmdlaunch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimoBechtel%2Fmdlaunch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimoBechtel%2Fmdlaunch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TimoBechtel","download_url":"https://codeload.github.com/TimoBechtel/mdlaunch/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247779701,"owners_count":20994568,"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":["generator","markdown","presentation","revealjs","slides","slideshow"],"created_at":"2024-10-11T01:42:15.035Z","updated_at":"2026-01-21T02:04:22.194Z","avatar_url":"https://github.com/TimoBechtel.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e📄🚀\u003cbr\u003emdlaunch\u003c/h1\u003e\n\u003ch3 align=\"center\"\u003eQuickly spin up a HTML presentation from any existing markdown file.\u003c/h3\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/mdlaunch\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Version\" src=\"https://img.shields.io/npm/v/mdlaunch.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/TimoBechtel/mdlaunch/blob/main/LICENSE\" target=\"_blank\"\u003e\n    \u003cimg alt=\"License: MIT\" src=\"https://img.shields.io/github/license/TimoBechtel/mdlaunch\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  ·\n  \u003ca href=\"https://github.com/TimoBechtel/mdlaunch#readme\"\u003eHomepage\u003c/a\u003e\n  ·\n  \u003ca href=\"https://timobechtel.github.io/mdlaunch/\"\u003eView Demo\u003c/a\u003e\n  ·\n  \u003ca href=\"https://github.com/TimoBechtel/mdlaunch/issues\"\u003eReport Bug / Request Feature\u003c/a\u003e\n  ·\n\u003c/p\u003e\n\n## Table of Contents\n\n- [About](#about)\n- [Prerequisites](#prerequisites)\n- [Usage](#usage)\n- [Examples](#examples)\n- [Test](#run-tests)\n- [Contact](#contact)\n- [Contributing](#Contributing)\n- [License](#license)\n\n## About\n\n**▶ [View this readme as slideshow generated with mdlaunch!](https://timobechtel.github.io/mdlaunch/)**\n\n`mdlaunch` was made to quickly create a HTML slideshow from any existing markdown files without making changes.\nSo you can spin up a presentation from your existings notes/wiki/etc.\n\nIt uses [Reveal.js](https://github.com/hakimel/reveal.js/) under the hood.\n\n## Prerequisites\nTo use it you need [Node](https://nodejs.org/en/) installed.\n\n## Usage\n\n```sh\nnpx mdlaunch YOUR_MARKDOWN_FILE\n```\n\nAnd open it with any webbrowser: http://localhost:5000\n\nYou can of course install it globally, if you want to:\n\n```sh\nnpm install --global mdlaunch\n```\n\nThen you can run `mdlaunch` directly.\n\n### Help screen: `mdlaunch --help`\n\n```\nmdlaunch \u003cfile\u003e\n\nbuild a presentation from a markdown file and  start a server (alias to\n\"mdlaunch serve \u003cfile\u003e --open\")\n\nCommands:\n  mdlaunch \u003cfile\u003e        build a presentation from a markdown file and  start a\n                         server (alias to \"mdlaunch serve \u003cfile\u003e --open\")\n                                                                          [default]\n  mdlaunch serve \u003cfile\u003e  build presentation from markdown and start a server\n  mdlaunch build \u003cfile\u003e  build a presentation\n\nPositionals:\n  port, p  port to bind server to                                         [number] [default: 5000]\n\nOptions:\n  --help              Display this help                                   [boolean]\n  --version           Display version                                     [boolean]\n  --output, -o        output directory                                    [string] [default: \"dist\"]\n  --separator, -s     regular expression for separating slides            [string]\n  --header-level, -l  maximum header level for separating slides          [number]\n  --port, -p          port to bind server to                              [number] [default: 5000]\n  --open              open browser after creating presentation            [boolean] [default: true]\n```\n\n## Examples\n\n```sh\n# Build a presentation to my-presentation without starting a server.\n# Also use any header with level 4 or lower to separate slides. (e.g. ### Header)\nmdlaunch build README.md --output \"my-presentation\" --header-level 4\n\n# Build a presentation and run it on port 3000. Also separate slides with \u003chr\u003e.\nmdlaunch FILE.md --port 3000 --separator \"\u003chr\u003e\"\n```\n\n## Contact\n\n👤 **Timo bechtel**\n\n- Website: https://timobechtel.com\n- Twitter: [@TimoBechtel](https://twitter.com/TimoBechtel)\n- GitHub: [@TimoBechtel](https://github.com/TimoBechtel)\n\n## 🤝 Contributing\n\nContributions, issues and feature requests are welcome!\u003cbr /\u003e\n\n1. Check [issues](https://github.com/TimoBechtel/mdlaunch/issues)\n1. Fork the Project\n1. Create your Feature Branch (`git checkout -b feat/AmazingFeature`)\n1. Test your changes `npm run test`\n1. Commit your Changes (`git commit -m 'feat: add amazingFeature'`)\n1. Push to the Branch (`git push origin feat/AmazingFeature`)\n1. Open a Pull Request\n\n### Commit messages\n\nThis project uses semantic-release for automated release versions. So commits in this project follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) guidelines. I recommend using [commitizen](https://github.com/commitizen/cz-cli) for automated commit messages.\n\n## Show your support\n\nGive a ⭐️ if this project helped you!\n\n## 📝 License\n\nDistributed under the [MIT](https://github.com/TimoBechtel/mdlaunch/blob/main/LICENSE) License.\n\n---\n\n_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimobechtel%2Fmdlaunch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimobechtel%2Fmdlaunch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimobechtel%2Fmdlaunch/lists"}