Table of Contents

• About
• Prerequisites
• Usage
• Examples
• Test
• Contact
• Contributing
• License

About

▶ View this readme as slideshow generated with 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 under the hood.

Prerequisites

To use it you need Node installed.

Usage

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:

npm install --global mdlaunch

Then you can run mdlaunch directly.

Help screen: mdlaunch --help

mdlaunch <file>

build a presentation from a markdown file and  start a server (alias to
"mdlaunch serve <file> --open")

Commands:
  mdlaunch <file>        build a presentation from a markdown file and  start a
                         server (alias to "mdlaunch serve <file> --open")
                                                                          [default]
  mdlaunch serve <file>  build presentation from markdown and start a server
  mdlaunch build <file>  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

# 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 <hr>.
mdlaunch FILE.md --port 3000 --separator "<hr>"

Contact

👤 Timo bechtel

• Website: https://timobechtel.com
• Twitter: @TimoBechtel
• GitHub: @TimoBechtel

🤝 Contributing

Contributions, issues and feature requests are welcome!

1. Check issues
2. Fork the Project
3. Create your Feature Branch (git checkout -b feat/AmazingFeature)
4. Test your changes npm run test
5. Commit your Changes (git commit -m 'feat: add amazingFeature')
6. Push to the Branch (git push origin feat/AmazingFeature)
7. Open a Pull Request

Commit messages

This project uses semantic-release for automated release versions. So commits in this project follow the Conventional Commits guidelines. I recommend using commitizen for automated commit messages.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Distributed under the MIT License.

This README was generated with ❤️ by readme-md-generator