wpreadme2markdown/wp2md

将WordPress插件readme.txt转换为Markdown格式的命令行工具

维护者

详细信息

github.com/wpreadme2markdown/wp2md

源代码

问题

安装次数: 45,096

依赖者: 6

建议者: 0

安全: 0

星级: 18

关注者: 2

分支: 3

公开问题: 0

4.0.2 2022-02-05 07:41 UTC

Requires

Requires (Dev)

MIT 73119d3a386d130b71705873b54aa523cc8d6e81

  • Benjamin J. Balter
  • Christian Archer <sunchaser.woop@sunchaser.info>

markdownwordpressconverterreadme

This package is auto-updated.

Last update: 2024-09-05 13:39:48 UTC

README

Packagist Code Climate

将WordPress插件readme文件转换为GitHub风格的Markdown格式。该工具基于WP Readme to Markdown Library

功能

  • 转换标题
  • 格式化贡献者、捐赠链接等
  • 插入截图

使用方法

# with files as params
wp2md -i readme.txt -o README.md
# or with unix pipes
wp2md < readme.txt > README.md

安装

Composer（推荐）

将Composer依赖项添加到您的项目中

"require-dev": {
    "wpreadme2markdown/wp2md": "*"
}

二进制文件将位于vendor/bin/wp2md

下载二进制文件

您可以将WP2MD二进制文件全局安装

sudo wget https://github.com/wpreadme2markdown/wp2md/releases/latest/download/wp2md.phar -O /usr/local/bin/wp2md
sudo chmod a+x /usr/local/bin/wp2md

PHAR编译

# install dependencies
composer install
# run pake build script
composer pake phar

可执行PHAR存档将创建为build/wp2md.phar

  • 这假设Composer已作为您的操作系统中的一项包安装。如果不是，请将composer替换为php命令和您的composer.phar位置（例如php ../phars/composer.phar）

网页版本

访问这个GitHub页面以获取网页版本及其运行实例的链接