Kirby Markdown Field 项目启动和配置文档

1. 项目目录结构及介绍

项目目录结构如下：

kirby-markdown-field/
├── .editorconfig
├── .eslintrc.js
├── .gitattributes
├── .gitignore
├── .github
├── .vscode
├── blueprints
│   └── blocks
├── composer.json
├── composer.lock
├── eslintrc.js
├── extension-examples
├── fields
├── index.css
├── index.js
├── index.php
├── LICENSE
├── README.md
├── package.json
├── package-lock.json
├── phpmd.xml.dist
├── phpunit.xml.dist
├── psalm.xml.dist
└── translations

• .editorconfig：定义代码编辑器设置，例如缩进风格、字符集等。
• .eslintrc.js：定义JavaScript代码的 lint 规则。
• .gitattributes：设置 Git 的属性，如文件类型和换行符。
• .gitignore：指定 Git 忽略的文件和目录。
• .github：包含 GitHub 项目的配置文件，如自动化的工作流。
• .vscode：包含 VS Code 的设置和扩展。
• blueprints：包含插件的蓝图文件，用于定义数据结构和用户界面。
• composer.json：定义项目的依赖项和设置。
• composer.lock：记录安装的依赖项版本。
• eslintrc.js：定义 JavaScript 代码的 lint 规则。
• extension-examples：包含插件扩展的示例代码。
• fields：包含插件的字段类型定义。
• index.css：包含插件的 CSS 样式。
• index.js：包含插件的 JavaScript 代码。
• index.php：插件的入口文件，定义插件的主要功能。
• LICENSE：项目的许可证文件，通常是 MIT 许可证。
• README.md：项目的自述文件，包含项目介绍、安装和使用说明。
• package.json：定义 Node.js 项目的依赖项和设置。
• package-lock.json：记录安装的 Node.js 依赖项版本。
• phpmd.xml.dist：定义 PHP Mess Detector 的配置。
• phpunit.xml.dist：定义 PHPUnit 测试框架的配置。
• psalm.xml.dist：定义 Psalm 静态分析工具的配置。
• translations：包含插件的翻译文件。

2. 项目的启动文件介绍

项目的启动文件是 index.php，它定义了插件的主要功能。该文件包含了插件的配置、字段类型定义和用户界面元素。

3. 项目的配置文件介绍

项目的配置文件是 composer.json 和 package.json。

• composer.json：定义项目的依赖项和设置，例如 Kirby CMS 的版本和插件的其他依赖项。
• package.json：定义 Node.js 项目的依赖项和设置，例如插件的 JavaScript 代码和样式文件。