Logseq 插件:Kanban Board 使用教程
1. 项目目录结构及介绍
logseq-plugin-kanban-board/
├── .github/
│ └── workflows/
│ └── deps
├── src/
│ ├── index.js
│ └── ...
├── .gitignore
├── .prettierrc
├── LICENSE
├── README.en.md
├── README.md
├── icon.png
├── package.json
├── rollup.config.mjs
└── yarn.lock
目录结构说明
- .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
- src/: 项目的源代码目录,包含主要的 JavaScript 文件。
- .gitignore: Git 忽略文件,指定哪些文件和目录不需要被版本控制。
- .prettierrc: Prettier 代码格式化配置文件。
- LICENSE: 项目的开源许可证文件。
- README.en.md: 英文版本的 README 文件。
- README.md: 中文版本的 README 文件。
- icon.png: 项目的图标文件。
- package.json: 项目的 npm 配置文件,包含项目的依赖和脚本。
- rollup.config.mjs: Rollup 打包工具的配置文件。
- yarn.lock: Yarn 包管理器的锁定文件,确保依赖版本一致。
2. 项目的启动文件介绍
src/index.js
src/index.js
是项目的入口文件,负责初始化插件并加载主要的逻辑代码。该文件通常包含以下内容:
- 插件初始化: 初始化 Logseq 插件的上下文。
- 事件监听: 监听 Logseq 的事件,如页面加载、块更新等。
- UI 渲染: 渲染看板视图,并处理用户交互。
3. 项目的配置文件介绍
package.json
package.json
是项目的 npm 配置文件,包含以下关键信息:
- name: 项目名称。
- version: 项目版本号。
- description: 项目描述。
- main: 项目的入口文件路径。
- scripts: 项目的脚本命令,如
start
、build
等。 - dependencies: 项目依赖的 npm 包列表。
- devDependencies: 开发环境依赖的 npm 包列表。
rollup.config.mjs
rollup.config.mjs
是 Rollup 打包工具的配置文件,用于将项目的源代码打包成最终的输出文件。配置文件通常包含以下内容:
- input: 入口文件路径。
- output: 输出文件路径和格式。
- plugins: 使用的 Rollup 插件列表,如 Babel、CommonJS 等。
.prettierrc
.prettierrc
是 Prettier 代码格式化工具的配置文件,用于统一项目的代码风格。配置文件通常包含以下内容:
- printWidth: 每行代码的最大长度。
- tabWidth: 缩进宽度。
- singleQuote: 是否使用单引号。
- semi: 是否在语句末尾添加分号。
通过以上配置文件和目录结构,开发者可以快速了解和上手 logseq-plugin-kanban-board
项目。