General Introduction
Moffee is an open source tool that turns Markdown files into professional slideshows quickly, simply and efficiently. Users only need to write Markdown content , Moffee can automatically handle the layout , paging and style , eliminating the need for manual layout of the trouble. It supports real-time preview, so users can see the effect while writing, and can also be exported to HTML or PDF files.Moffee is developed in Python, and requires a minimum Python 3.10 environment. It is designed to make slide production easier, suitable for people who need to quickly generate presentations.
Tip big model you want to use Moffee syntax to generate markdown format document, and repeat the emphasis on the statement that the generated markdown format document used to generate Moffee syntax PPT slides. This is the basic principle of all AIPPT products. The reason for bringing up this product again is that recently a group of traffic must be converted to PPT with Claude documents.
Function List
- Convert Markdown files to slideshows with one click, with automatic paging and title selection.
- Provide real-time preview function, while editing Markdown to see the effect of the slide show.
- Support multiple themes, such as default, beam, robo, blue, gaia, easy to switch styles.
- Allows customization of the layout and CSS styles, such as adjusting the background color or fonts.
- Use a separator (e.g.
---
,===
,) Flexible arrangement of text and images.
- Supports exporting slides as HTML or PDF files for easy sharing or presentation.
- Built-in math formulas (such as
) and code block rendering for technical presentations.
Using Help
Installation process
Moffee requires a Python environment to run, here are the installation steps:
- Checking the Python Version
Open a terminal and typepython --version
maybepython3 --version
If you have a version 3.10 or higher, make sure it's 3.10 or higher. If it's lower than that, you'll need to upgrade Python first. - Creating a virtual environment (optional but recommended)
Create a clean environment by typing the following command in the terminal:
conda create -n moffee_py310 python=3.10
conda activate moffee_py310
Or use venv, which comes with Python:
python3 -m venv moffee_env
source moffee_env/bin/activate # Mac/Linux
moffee_env\Scripts\activate # Windows
- Installing Moffee
After activating the environment, enter the following command to install it:
pip install moffee
After the installation is complete, you can use the moffee --version
Check for success.
- Preparing the Markdown file
Create a new.md
files, such asexample.md
, write the content. You can use any text editor, such as VS Code or Notepad.
How to use
Moffee offers two main ways to use it: live preview and exporting files.
Real-time preview function
- Go to the folder where the Markdown files are located in the terminal.
expense or outlaycd
command to switch directories, for example:
cd /path/to/your/folder
- Start the local service.
Enter the following command:
moffee live example.md
Upon startup, Moffee will run a web server locally at the default address of http://127.0.0.1:5500/
The
- Open your browser to view it.
Type in your browserhttp://127.0.0.1:5500/
If you want to see the slideshow effect, you will be able to see the slideshow effect. When editing a Markdown file, the page is automatically updated.
Export Slides
- If you don't need a live preview, you can export it directly.
Enter the command:
moffee make example.md -o output_html/
This generates a output_html
folder, which contains the HTML files for the slides.
- View export results.
show (a ticket)output_html
folderindex.html
You can view the slideshow with your browser. Tools can also be used to convert HTML to PDF.
Featured Function Operation
- Writing Markdown files
Moffee supports simple Markdown syntax. For example:
# Title.
This is a paragraph of text.
- List item 1
- List item 2
These are automatically converted to slide pages.
- tab delimiter
expense or outlay---
Separate different pages:
First page content
----------
Second page content
- landscape
expense or outlayPut the text on the same line as the image:
Text ! [Image](https://placehold.co/600x400)
- vertical alignment
expense or outlay===
Separate upper and lower content:
Top
========
Bottom half
- Custom Styles
Add front matter to the beginning of the file to set the style:
---
theme: blue
background-color: lightgray
---------------------------
# Content
This allows you to change the theme or background color.
- Math formulas and codes
Write formulas or code directly and Moffee will render it automatically:
Formula: $E = mc^2$
Code: `print("Hello")`
Example of operation flow
Let's say you're going to make a technical sharing slide show:
- newly built
tech.md
file, write:
---
theme: robo
aspect_ratio: "16:9"
--------------------
# Technical Sharing
Talking about Moffee today.
-----------------
## Features
- Easy to use
- Real-time preview
- (of a computer) run
moffee live tech.md
, open the browser to see the effect. - Adjust the content to your satisfaction with
moffee make tech.md -o tech_slides/
Export.
application scenario
- Teaching Demonstration
Teachers can use Moffee to turn lesson notes into slides and quickly prepare for class. - Technology Sharing
Developers can use it to organize technical documentation and generate presentation files for meetings. - Individual speeches
People who need to give presentations can write scripts in Markdown and turn them into professional slides right away.
QA
- What operating systems does Moffee support?
It works on Windows, Mac, and Linux as long as you have Python 3.10 or higher. - How do I fix a failed startup?
Check that the Python version is correct, and make sure that you use thepip install moffee
The installation was successful. If you still have problems, try updating the pip:pip install --upgrade pip
The - Can it be used offline?
Can. No internet connection is required after installation, and the slideshow is generated directly with the command.