Installation Guide for Moffee

Prerequisites

For a basic installation of pipx, you can use pip:

pip install pipx

For more detailed installation instructions or if you encounter any issues, please refer to the official pipx documentation.

Moffee is a Python package and is recommended to be installed using pipx:

pipx install moffee

Alternatively, if you prefer to use pip directly:

pip install moffee

To verify that Moffee has been installed correctly, you can run:

moffee --version

This should display the version number of Moffee installed on your system.

Once installed, you can use Moffee to preview slides in a live web server or export them to HTML:

moffee live example.md

This command will launch a local server and open your default web browser to display the slides.

moffee make example.md -o output_html/

This command will generate HTML files in the specified output_html/ directory.

For more advanced usage and configuration options, refer to the Moffee documentation or run moffee --help.