GitHub Flavored Markdown for WordPress 使用教程

GitHub Flavored Markdown for WordPress 使用教程

wp-gfmWordPress Plugin for PHP-Markdown and GitHub Flavored Markdown项目地址:https://gitcode.com/gh_mirrors/wp/wp-gfm

项目介绍

GitHub Flavored Markdown for WordPress（简称 wp-gfm）是一个开源插件，旨在为 WordPress 网站提供 GitHub Flavored Markdown 和 PHP-Markdown 的支持。通过使用短代码 [gfm] 和 [markdown]，用户可以在 WordPress 内容中轻松应用 Markdown 语法。

项目快速启动

安装插件

1. 下载插件文件：

   git clone https://github.com/makotokw/wp-gfm.git
   

2. 将下载的文件夹上传到 WordPress 站点的 wp-content/plugins 目录。
3. 在 WordPress 后台的“插件”页面中激活 GitHub Flavored Markdown for WordPress 插件。

使用短代码

在 WordPress 文章或页面中使用以下短代码来应用 Markdown 语法：

[gfm]
# 这是一个标题
 
**这是加粗的文本**
 
- 列表项1
- 列表项2
[/gfm]

或者使用 PHP-Markdown 短代码：

[markdown]
# 这是一个标题
 
**这是加粗的文本**
 
- 列表项1
- 列表项2
[/markdown]

应用案例和最佳实践

应用案例

1. 技术博客：使用 Markdown 语法编写技术文章，使代码块和格式更加清晰。
2. 文档网站：利用 Markdown 的简洁语法编写项目文档，提高可读性和维护性。

最佳实践

1. 代码高亮：使用 fenced code blocks 来高亮代码，例如：

   [gfm]
   ```php
   function hello() {
       echo "Hello, World!";
   }
   

   [/gfm]

2. 自动链接：启用自动链接功能，使 URL 自动转换为可点击的链接。
3. 一致性：在整个网站中统一使用 Markdown 语法，提高内容的一致性和可维护性。

典型生态项目

相关插件

1. WP-Markdown：另一个流行的 Markdown 插件，提供更多的自定义选项。
2. Code Prettify：用于代码高亮的插件，与 wp-gfm 结合使用效果更佳。

相关工具

1. Markdown 编辑器：如 Typora、Visual Studio Code 等，用于编写和预览 Markdown 内容。
2. 版本控制工具：如 Git，用于管理 Markdown 文档的版本和变更。

通过以上模块的介绍，您可以快速上手并充分利用 GitHub Flavored Markdown for WordPress 插件，提升 WordPress 站点的内容编写体验。

wp-gfmWordPress Plugin for PHP-Markdown and GitHub Flavored Markdown项目地址:https://gitcode.com/gh_mirrors/wp/wp-gfm