dpwlabs / yii2-markdown-pages
简单的平面文件Markdown渲染器
2.2.2
2018-03-26 11:39 UTC
Requires
- php: >=7.0
- hyn/frontmatter: ~1.1
- yiisoft/yii2: *
Requires (Dev)
- codeception/base: ^2.2.3
- codeception/codeception: ^2.2
- codeception/specify: ~0.4.3
- codeception/verify: ~0.3.1
README
yii2-markdown-pages提供了一种简单的方法,在单个Markdown文件中编写页面,带有YAML前端信息,动态渲染它们,并按您的喜好使用渲染后的HTML和前端信息。
更新您的Yii2网站或拥有一个简单的博客或新闻源列表。将您的帖子存储在版本控制中,与您的其他代码一起。 无需数据库!
此扩展是从CorWatts/yii2-markdown-files派生的
安装
通过composer安装
composer require 'dpwlabs/yii2-markdown-pages'
配置
通过将以下代码片段添加到您的main.php配置文件中,启用该模块。
'modules' => [ 'pages' => [ // name this module what you like 'class' => \dpwlabs\MarkdownPages\Module::className(), 'pages' => '@frontend/views/markdown/pages', 'drafts' => '@frontend/views/markdown/drafts', ] ],
class
: 是此模块的命名空间类pages
: 是指向包含可发布Markdown文件的目录的路径。该路径可以包含Yii2别名。drafts
: 是指向包含尚未准备发布的Markdown文件的目录的路径。该路径可以包含Yii2别名。 草稿只在Yii2dev
环境中渲染。
注意:如果您要使用包含在此扩展中的控制台命令,请确保在控制台应用程序可以访问的位置添加此配置(例如common/config/main.php
)。
用法
在渲染和显示帖子之前,必须创建单个帖子文件。使用此扩展中包含的控制台命令快速构建新帖子是一种简单的方法。下面是如何设置和使用它的说明。
创建新帖子很容易,无需 包含的控制台命令。帖子遵循特定的规则集
- 在上面的模块配置中指定的
pages
或drafts
目录路径中创建一个文件。 - 类似于Jekyll,文件名具有特定的格式。它应该以日期(YYYY-MM-DD格式)开头,然后是snake_cased描述,并以
.md
扩展名结束。例如2017-05-20_test_post_1.md
。当这些文件被处理时,日期将从文件名中提取出来。描述性的文件名其余部分用于使用page()
方法时选择。