README

基于 Markdown 的 CodeIgniter 4 框架页面。

安装

composer require michalsn/codeigniter-markdown-pages

基本使用

为了轻松演示事物是如何工作的，我们将暂时假设这是我们的文件夹结构。

├── app
├── content
│   ├── 1_quick-start
│   │   ├── 1_installation.md
│   │   ├── 2_database-migration.md
│   │   ├── what-next.md
│   │   └── subfolder
│   │       └── one-file.md
│   └── first-steps
│       ├── available-methods.md
│       └── how-to-use-this.md
├── public
├── tests
├── vendor
└── writable

现在我们必须使用我们的文件夹初始化 Markdown 页面

$markdownPages = services('markdownpages', ROOTPATH . 'content');

$dir = $markdownPages->dirs()->first();

echo $dir->getName()
// prints: Quick Start

echo $dir->getSlug()
// prints: quick-start

foreach($dir->getFiles()->items() as $file) {
    echo $file->getName();
    // prints: Installation

    echo $file->getSlug();
    // prints: installation

    echo $file->getPath();
    // prints: quick-start/installation

    echo $content->parse()->getContent();
    // prints: parsed markdown from file

    echo $content->parse()->getMeta();
    // prints: parsed YAML as key -> value
}

我们在几乎每个地方都使用了 Collection 类，所以请熟悉它以便舒适地使用此包。

文档

https://michalsn.github.io/codeigniter-markdown-pages/

michalsn / codeigniter-markdown-pages

维护者

详细信息

README

安装

基本使用

文档