Ficus 开源项目快速入门指南

1. 项目目录结构及介绍

Ficus 是一个由 gg=G 团队开发的用于编辑和管理Markdown文档的软件。其项目结构精心设计以支持高效的Markdown文件编辑和浏览体验。以下是关键的目录结构概览：

├── build                     # 构建所需资源
│
├── public                    # 公共艺术风格资源，包括CSS主题
│   └── css
│       ├── content-theme
│
├── src                       # 项目源代码
│   ├── common                # 共享资源
│   ├── IR                    # FicIR（内部表示），处理Markdown解析的核心逻辑
│   │   ├── block             # 基本数据结构
│   │   ├── component         # 高级数据结构
│   │   └── ...               # 包括工厂方法、历史记录等
│   ├── main                  # Electron后端逻辑，涉及文件操作、工具方法等
│   └── renderer              # Vue前端实现，含组件、资产、存储和工具
│       ├── components        # Vue组件，如富文本编辑器、侧边栏等
│       ├── store             # 状态管理
│       └── ...
│
├── test                      # 单元测试文件
│
├── yarn.lock                 # Yarn依赖锁文件
└── package.json              # 项目配置文件，包含脚本命令、依赖等

2. 项目的启动文件介绍

在Ficus项目中，并没有特定提到“启动文件”的概念，但其运行机制主要通过package.json中的脚本来驱动。若要进行本地开发或构建应用程序，主要依赖以下两个关键脚本命令：

• 构建应用:

  yarn electron:build
  

  这将编译并打包应用，用于生产环境。

• 运行开发者模式:

  yarn electron:serve
  

  提供实时重载功能，适合开发时调试。

实际上，启动过程是通过调用上述Yarn命令来间接执行的，它们背后依赖于Electron和Vue CLI的服务来启动应用或进行构建。

3. 项目的配置文件介绍

主配置文件：package.json

• 定义了项目的名称、版本、作者信息、依赖库以及一系列的npm脚本命令。这些脚本如electron:build和electron:serve控制着项目的构建和运行流程。

{
  "scripts": {
    "electron:build": "...", // 构建命令
    "electron:serve": "...", // 开发服务器命令
    ...
  },
  "dependencies": { ... }, // 第三方依赖列表
  "devDependencies": { ... } // 开发工具依赖列表
}

其他重要配置文件

• .gitignore 和 .npmrc：忽略文件和npm配置，用于控制版本控制忽略项和npm行为。
• babel.config.js, eslintrc.js: 指定JavaScript代码转换规则和编码规范。
• vue.config.js: Vue CLI的特殊配置，调整Webpack配置等高级选项。
• postcss.config.js, tailwind.config.js: CSS处理相关配置，特别是对于Tailwind CSS的定制。

综上所述，Ficus项目通过明确的目录结构、基于脚本的启动方式以及详细配置文件来确保开发者的高效工作流，使得从构建到部署的过程清晰可控。开发者可以依据这些指导轻松地介入项目，无论是进行开发还是自定义配置。