经验 / smartdown
将Markdown Extra和Smartypants的无拘无束的喜悦带给您的Craft网站。
Requires
- craftcms/cms: ^3.0.0
- michelf/php-markdown: ^1.8
- michelf/php-smartypants: ^1.8
Requires (Dev)
- codeception/codeception: dev-master
This package is auto-updated.
Last update: 2021-08-21 17:44:47 UTC
README
Smartdown for Craft是一个Twig过滤器,它将Markdown Extra和SmartyPants的无拘无束的喜悦带给Craft。
Craft已经支持标准的Markdown,但遗憾的是,标准的Markdown不支持许多有用的功能,如脚注、代码块和表格。它也没有为您的排版增添色彩,导致您的网站出现直引号和假省略号,让人尴尬。
Smartdown填补了这两个空白,使您的网站成为一个排版梦幻船。
要求
Smartdown的每个版本都会自动针对PHP 7.1及以上版本进行测试。它还在Craft的最新版本上手动测试。
PHP 7.0支持
理论上,Smartdown应该与PHP 7.0兼容。实际上,由于Codeception依赖树包含仅适用于PHP 7.1+的组件,因此无法测试这一点。
遗憾的是,我们对此无能为力。
安装
要安装Smartdown,可以在Craft插件商店中搜索“Smartdown”,或将它作为Composer依赖项添加。
以下是使用Composer安装Smartdown的方法。
-
打开您的终端,并导航到您的Craft项目
cd /path/to/project
-
将Smartdown作为项目依赖项添加
composer require experience/smartdown
-
在控制面板中,转到“设置→插件”,然后点击Smartdown的“安装”按钮
基本用法
使用Smartdown过滤器的方式与任何其他Twig过滤器完全相同。
{{ myVariable|smartdown }}
这将解析您的文本内容,使用Markdown Extra和SmartyPants,将以下内容
"Outside of a dog, a book is a man's best friend. Inside a dog it's too dark to read..."
转换为以下内容
"除了狗,一本书是人类最好的朋友。在狗里面太黑了,看不清..."
过滤器参数
标记
markup
过滤器参数控制是否使用Markdown Extra解析文本。默认值为true
。
示例用法
{{ content|smartdown(markup=false) }}
排版
typography
过滤器参数控制是否使用SmartyPants解析文本。默认值为true
。
示例用法
{{ content|smartdown(typography=false) }}