Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timobechtel/mdlaunch
Quickly spin up a HTML presentation from any existing markdown file.
https://github.com/timobechtel/mdlaunch
generator markdown presentation revealjs slides slideshow
Last synced: 19 days ago
JSON representation
Quickly spin up a HTML presentation from any existing markdown file.
- Host: GitHub
- URL: https://github.com/timobechtel/mdlaunch
- Owner: TimoBechtel
- License: mit
- Created: 2020-04-30T22:04:46.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-06T04:42:40.000Z (almost 2 years ago)
- Last Synced: 2024-10-12T01:42:42.774Z (about 1 month ago)
- Topics: generator, markdown, presentation, revealjs, slides, slideshow
- Language: JavaScript
- Homepage: https://timobechtel.github.io/mdlaunch/
- Size: 926 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
📄🚀
mdlaunch
Quickly spin up a HTML presentation from any existing markdown file.
·
Homepage
·
View Demo
·
Report Bug / Request Feature
·
## Table of Contents
- [About](#about)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [Examples](#examples)
- [Test](#run-tests)
- [Contact](#contact)
- [Contributing](#Contributing)
- [License](#license)
## About
**▶ [View this readme as slideshow generated with mdlaunch!](https://timobechtel.github.io/mdlaunch/)**
`mdlaunch` was made to quickly create a HTML slideshow from any existing markdown files without making changes.
So you can spin up a presentation from your existings notes/wiki/etc.
It uses [Reveal.js](https://github.com/hakimel/reveal.js/) under the hood.
## Prerequisites
To use it you need [Node](https://nodejs.org/en/) installed.
## Usage
```sh
npx mdlaunch YOUR_MARKDOWN_FILE
```
And open it with any webbrowser: http://localhost:5000
You can of course install it globally, if you want to:
```sh
npm install --global mdlaunch
```
Then you can run `mdlaunch` directly.
### Help screen: `mdlaunch --help`
```
mdlaunch
build a presentation from a markdown file and start a server (alias to
"mdlaunch serve --open")
Commands:
mdlaunch build a presentation from a markdown file and start a
server (alias to "mdlaunch serve --open")
[default]
mdlaunch serve build presentation from markdown and start a server
mdlaunch build build a presentation
Positionals:
port, p port to bind server to [number] [default: 5000]
Options:
--help Display this help [boolean]
--version Display version [boolean]
--output, -o output directory [string] [default: "dist"]
--separator, -s regular expression for separating slides [string]
--header-level, -l maximum header level for separating slides [number]
--port, -p port to bind server to [number] [default: 5000]
--open open browser after creating presentation [boolean] [default: true]
```
## Examples
```sh
# Build a presentation to my-presentation without starting a server.
# Also use any header with level 4 or lower to separate slides. (e.g. ### Header)
mdlaunch build README.md --output "my-presentation" --header-level 4
# Build a presentation and run it on port 3000. Also separate slides with
.
mdlaunch FILE.md --port 3000 --separator "
"
```
## Contact
👤 **Timo bechtel**
- Website: https://timobechtel.com
- Twitter: [@TimoBechtel](https://twitter.com/TimoBechtel)
- GitHub: [@TimoBechtel](https://github.com/TimoBechtel)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
1. Check [issues](https://github.com/TimoBechtel/mdlaunch/issues)
1. Fork the Project
1. Create your Feature Branch (`git checkout -b feat/AmazingFeature`)
1. Test your changes `npm run test`
1. Commit your Changes (`git commit -m 'feat: add amazingFeature'`)
1. Push to the Branch (`git push origin feat/AmazingFeature`)
1. Open a Pull Request
### Commit messages
This 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.
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Distributed under the [MIT](https://github.com/TimoBechtel/mdlaunch/blob/main/LICENSE) License.
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_