gnowland/markdown-wordpress-docs

从 Markdown 文件生成 WordPress 网站文档

维护者

详细信息

github.com/gnowland/markdown-wordpress-docs

源代码

问题

安装: 0

依赖项: 0

建议者: 0

安全性: 0

星标: 1

关注者: 2

分支: 0

开放问题: 2

语言:CSS

v1.0.0 2020-11-05 03:53 UTC

Requires

GPL-2.0-or-later 55905ffff4d045fa632ee4cfe54174c5b608d2a0

  • Gifford Nowland <hi.woop@giffordnowland.com>

This package is auto-updated.

Last update: 2024-09-05 14:35:09 UTC

README

GitHub release | Packagist | buymeacoffee.com/gnowland

一个轻量级的 WordPress 插件，可以从 Markdown 文件为您的 WordPress 网站生成管理文档/帮助页面。

使用方法

  1. 将 Markdown 文件添加到 docs/
  2. 安装 & 在 WordPress 管理后台激活插件

详细信息

  • /docs 应包含所有您的 Markdown 文件
  • 链接到 ../[DOCUMENT_NAME.md]，./[DOCUMENT_NAME.md] 或 docs/[DOCUMENT_NAME.md] 将自动通过 URL 参数 ?page=docs&doc=[DOCUMENT_NAME].md 路由到显示文件
    • 我建议将文件按主题划分，并在 docs/README.md 中包括一个目录。
  • 帮助页面将在仪表板的子菜单中显示

安装

Composer

composer require gnowland/markdown-wordpress-documentation

使用 wp-cli 激活

wp plugin activate markdown-wordpress-documentation

或者在 WordPress 管理面板中。

Git

  • 将 git clone 到您的站点插件文件夹中
  • 通过 WordPress 或 wp-cli（见上方）或在 WordPress 管理后台激活

手动

  • 下载 最新版本 作为 .zip 文件
  • 解压到您的站点插件文件夹中
  • 通过 WordPress 管理后台或 wp-cli（见上方）激活