Directus Extension EditorJS 接口使用教程
1. 项目的目录结构及介绍
directus-extension-editorjs-interface/
├── github/workflows/
├── src/
│ ├── editorconfig
│ ├── gitignore
│ ├── LICENSE.txt
│ ├── README.md
│ ├── package-lock.json
│ ├── package.json
│ ├── screenshot.png
│ └── tsconfig.json
└── README.md
github/workflows/
: 包含 GitHub Actions 的工作流配置文件。src/
: 项目的源代码目录。editorconfig
: 编辑器配置文件。gitignore
: Git 忽略文件配置。LICENSE.txt
: 项目许可证文件。README.md
: 项目说明文档。package-lock.json
: npm 依赖锁定文件。package.json
: 项目依赖和脚本配置文件。screenshot.png
: 项目截图。tsconfig.json
: TypeScript 配置文件。
2. 项目的启动文件介绍
项目的启动文件主要是 package.json
中的脚本配置。以下是一些关键的脚本:
{
"scripts": {
"build": "npm run build",
"start": "npm start"
}
}
build
: 用于构建项目。start
: 用于启动项目。
3. 项目的配置文件介绍
主要的配置文件包括:
package.json
: 包含项目的依赖、脚本和其他配置。tsconfig.json
: TypeScript 编译配置文件。editorconfig
: 编辑器配置文件,用于统一代码风格。
package.json
{
"name": "directus-extension-editorjs-interface",
"version": "1.0.0",
"description": "Block-styled editor for rich media stories outputs clean data in JSON",
"main": "dist/index.js",
"scripts": {
"build": "npm run build",
"start": "npm start"
},
"dependencies": {
"directus-extension-editorjs": "^1.0.0"
},
"license": "GPL-3.0"
}
tsconfig.json
{
"compilerOptions": {
"target": "es5",
"module": "commonjs",
"outDir": "./dist",
"strict": true,
"esModuleInterop": true
}
}
editorconfig
root = true
[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
以上是 directus-extension-editorjs-interface
项目的基本目录结构、启动文件和配置文件的介绍。希望这份文档能帮助你更好地理解和使用该项目。