Kirby Visual Markdown 项目教程

Kirby Visual Markdown 项目教程

kirby-visual-markdownVisual Markdown Editor for Kirby CMS 2项目地址:https://gitcode.com/gh_mirrors/ki/kirby-visual-markdown

1. 项目的目录结构及介绍

kirby-visual-markdown/
├── assets/
│   ├── css/
│   ├── js/
├── config/
├── index.php
├── license.md
├── readme.md
└── src/
    ├── editor/
    ├── toolbar/
    └── utils/

• assets/: 包含项目的静态资源文件，如CSS和JavaScript文件。
• config/: 包含项目的配置文件。
• index.php: 项目的入口文件。
• license.md: 项目的许可证文件。
• readme.md: 项目的说明文档。
• src/: 包含项目的源代码文件，如编辑器、工具栏和工具类等。

2. 项目的启动文件介绍

项目的启动文件是 index.php，它负责初始化应用程序并加载必要的资源和配置。以下是 index.php 的主要内容：

<?php

require __DIR__ . '/vendor/autoload.php';

use Kirby\Cms\App as Kirby;

$kirby = new Kirby([
    'roots' => [
        'index'    => __DIR__,
        'assets'   => __DIR__ . '/assets',
        'config'   => __DIR__ . '/config',
        'site'     => __DIR__ . '/site',
        'storage'  => __DIR__ . '/storage'
    ]
]);

echo $kirby->render();

• autoload.php: 自动加载Composer管理的依赖。
• Kirby: 初始化Kirby CMS应用实例。
• roots: 定义项目的根目录和子目录。
• render(): 渲染并输出应用程序。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，通常包含 config.php 文件。以下是 config.php 的主要内容：

<?php

return [
    'debug'  => true,
    'languages' => true,
    'routes' => [
        [
            'pattern' => '(:all)',
            'action'  => function ($path) {
                return Site::visit($path);
            }
        ]
    ],
    'markdown' => [
        'extra' => true,
        'breaks' => true,
        'safe' => false
    ]
];

• debug: 开启调试模式。
• languages: 启用多语言支持。
• routes: 定义路由规则。
• markdown: 配置Markdown渲染选项，如启用Markdown Extra、自动换行和安全模式。

以上是Kirby Visual Markdown项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。

kirby-visual-markdownVisual Markdown Editor for Kirby CMS 2项目地址:https://gitcode.com/gh_mirrors/ki/kirby-visual-markdown