romaninsh / mdcms
适用于Agile Toolkit的Markdown CMS
1.1.4
2016-07-13 11:33 UTC
Requires
- atk4/atk4: ^4.3
- erusev/parsedown: ~1.4
- erusev/parsedown-extra: dev-master
This package is auto-updated.
Last update: 2024-09-14 10:00:29 UTC
README
这是一个Agile Toolkit的插件,可以帮助您在页面上显示Markdown内容。要使用它,请将以下代码添加到您的Frontend.php / init()中:
$this->add('romaninsh/mdcms/Controller');
然后在您的interface
文件夹内创建“content”文件夹
frontend
+ page
+ lib
+ public
+ content
创建content/hello.md
,然后在浏览器中打开frontend/public/hello
,您应该能看到Markdown内容实时显示。
功能和组件
此插件可以通过多种方式集成。上面的集成是一个完整集成,但您也可以使用单个组件。
- 应用程序控制器 - 全功能集成,一行即可使用。
- romaninsh/mdcms/Page - 具备将常规模板与Markdown混合的页面扩展。
{markdown} .. {/}
- 允许您在常规ATK模板中嵌入Markdown{markdown_include}disclaimer{}
- 包含Markdown文件。建议以下划线开头包含文件,这样就不能直接访问。
映射图像和URL
要使用url()包装器链接到ATK页面,请在Markdown中使用{page}my-page{/}。这将自动替换为正确的URL。
要包含指向公共图像的链接,请使用![image],URL将自动使用locateURL('public', $url)转换。建议将您的图像放在content/images中,并创建指向public/images的符号链接。使用将正确地在文本编辑器和您的网站上工作。
缓存
此附加组件支持模型。这使您可以使用透明缓存和/或存储模板在专用存储中。例如,要将模板存储在memcache中,可以使用以下代码:
$this->add('romaninsh/mdcms/Controller')
->setModel('romaninsh/mdcms/Model')
->setSource('Memcached');
资源
默认情况下,.md文件存储在'content'文件夹中,但您可以通过通过pathfinder添加更多扩展来添加更多。资源类型为content
。