FLYMD 开源项目教程

FLYMD 开源项目教程

flymdflymd – Emacs on the fly markdown preview项目地址:https://gitcode.com/gh_mirrors/fl/flymd

1、项目的目录结构及介绍

FLYMD 项目的目录结构如下：

flymd/
├── browser.md
├── flymd.el
├── flymd.html
├── LICENSE
├── README.md
└── .gitignore

• browser.md: 用于浏览器预览的 Markdown 文件。
• flymd.el: 主要配置和功能实现文件。
• flymd.html: 用于生成预览的 HTML 文件。
• LICENSE: 项目许可证文件，采用 GPL-3.0 许可证。
• README.md: 项目说明文档。
• .gitignore: Git 忽略文件配置。

2、项目的启动文件介绍

FLYMD 项目的启动文件是 flymd.el。该文件包含了项目的核心功能和配置。用户可以通过加载该文件来启用 FLYMD 插件。

(require 'flymd)

启动 FLYMD 的命令是：

M-x flymd-flyit

执行该命令后，当前的 Markdown 缓冲区会在浏览器中打开预览。

3、项目的配置文件介绍

FLYMD 项目的配置文件主要是 flymd.el。该文件中包含了用户可以自定义的选项。以下是一些重要的配置选项：

• flymd-close-buffer-delete-temp-files: 配置是否在关闭缓冲区时删除临时文件。
• flymd-browser-open-function: 配置浏览器打开函数。

用户可以根据自己的需求在 flymd.el 文件中进行相应的配置。

(setq flymd-close-buffer-delete-temp-files t)
(setq flymd-browser-open-function 'browse-url-generic)

以上配置选项可以在 flymd.el 文件中找到并进行修改。

通过以上教程，用户可以了解 FLYMD 项目的目录结构、启动文件和配置文件，从而更好地使用和定制该开源项目。

flymdflymd – Emacs on the fly markdown preview项目地址:https://gitcode.com/gh_mirrors/fl/flymd