{"id":15048722,"url":"https://github.com/thysrael/ficus","last_synced_at":"2025-04-05T07:08:20.480Z","repository":{"id":152722368,"uuid":"614756527","full_name":"Thysrael/Ficus","owner":"Thysrael","description":"Ficus is a software for editing and managing markdown documents, developed by the  gg=G team.","archived":false,"fork":false,"pushed_at":"2024-08-23T06:21:29.000Z","size":80438,"stargazers_count":381,"open_issues_count":30,"forks_count":17,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-29T06:09:21.557Z","etag":null,"topics":["electron","javascript","markdown-editor","notes-app","vue"],"latest_commit_sha":null,"homepage":"https://ficus.world/","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Thysrael.png","metadata":{"files":{"readme":"README-zh.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-16T08:57:48.000Z","updated_at":"2025-02-25T14:43:08.000Z","dependencies_parsed_at":"2024-08-23T07:44:52.410Z","dependency_job_id":null,"html_url":"https://github.com/Thysrael/Ficus","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thysrael%2FFicus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thysrael%2FFicus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thysrael%2FFicus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thysrael%2FFicus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Thysrael","download_url":"https://codeload.github.com/Thysrael/Ficus/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247299833,"owners_count":20916190,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","javascript","markdown-editor","notes-app","vue"],"created_at":"2024-09-24T21:15:44.318Z","updated_at":"2025-04-05T07:08:20.454Z","avatar_url":"https://github.com/Thysrael.png","language":"Vue","readme":"\u003cp align = \"center\"\u003e\n\u003cimg src=\"https://i.postimg.cc/NfqfDkRb/001.png\" width=\"270px\" /\u003e\n\u003cbr\u003e\u003cbr\u003e\n\u003cimg src=\"https://img.shields.io/github/languages/top/thysrael/ficus\" /\u003e\n\u003cimg src=\"https://img.shields.io/github/downloads/thysrael/ficus/total\" /\u003e\n\u003cimg src=\"https://img.shields.io/github/issues/thysrael/ficus\" /\u003e\n\u003cimg src=\"https://img.shields.io/github/issues-pr-closed-raw/thysrael/ficus\"\u003e\n\u003cimg src=\"https://img.shields.io/github/release-date/thysrael/ficus\"\u003e\n\u003cbr\u003e\u003cbr\u003e\n\u003c/p\u003e\n\n\n\n\n\u003ch1 align=\"center\"\u003eFicus\u003c/h1\u003e\n\nREADME: [汉语](./README-zh.md) | [English](./README.md)\n\n$\\tt{Ficus}$ 是一款 `markdown` 文档的编辑管理软件，由 $\\tt{gg=G}$ 团队开发。\n\n$\\tt{Ficus}$ 释义为“榕树”，榕树具有“冠盖如伞、一木成林“的特点。这也恰是本款软件想要为用户提供的核心服务：让用户的 md 文档可以像一棵榕树一样被浏览和编辑，同时让用户的多个 md 文档像榕树林一样进行多种形式的关联。我们希望用户的体验如这款软件的标语一样：\n\n\u003cp align = \"center\"\u003e\n\u003cimg src=\"./img/slogan.png\"/\u003e\n\u003c/p\u003e\n\n$\\tt{Ficus}$ 基于 `Vue3, Electron` 框架开发，提供 Windows、macOS 和 Linux 系统的安装包。\n\n详细信息可以在[ficus官网](https://ficus.world/)进一步了解。\n\n\n\n## 先览\n\n**富文本模式**\n\n\u003cp align = \"center\"\u003e\n\u003cimg src=\"./img/rtext.png\"/\u003e\n\u003c/p\u003e\n\n**源码模式**\n\n\u003cp align = \"center\"\u003e\n\u003cimg src=\"./img/src.png\"/\u003e\n\u003c/p\u003e\n\n**榕树模式**\n\n\u003cp align = \"center\"\u003e\n\u003cimg src=\"./img/ftree.png\"/\u003e\n\u003c/p\u003e\n\n**榕林模式**\n\n\u003cp align = \"center\"\u003e\n\u003cimg src=\"./img/fforest.png\"/\u003e\n\u003c/p\u003e\n\n**榕图模式**\n\n\u003cp align = \"center\"\u003e\n\u003cimg src=\"./img/fgraph.png\"/\u003e\n\u003c/p\u003e\n\n\n## 构建\n\n可以在[下载链接](https://ficus.world/pages/53ff34/)处直接下载打包的应用。\n\n如果希望自己构建，建议使用 node v16.19.1 版本，预先安装好 yarn 包管理器，使用 yarn 进行包管理。在 shell 中执行如下操作：\n\n```shell\ngit clone git@github.com:Thysrael/Ficus.git\ncd ./Ficus/\nyarn install\nyarn electron:build\n```\n\n在`Ficus/dist_electron/linux_unpacked` 或 `Ficus/dist_electron/win_unpacked` 就是成品的构建结果。\n\n需要注意安装路径中不能有**中文**，同时对于 win 用户，安装程序中只支持 `Only for me ` 选项：\n\n\u003cp align = \"center\"\u003e\n\u003cimg src=\"./img/only.png\"/\u003e\n\u003c/p\u003e\n\n\n\n## 运行\n\n建议使用 node v16.19.1 版本，预先安装好 yarn 包管理器，使用 yarn 进行包管理。在 shell 中执行如下操作：\n\n```shell\ngit clone git@github.com:Thysrael/Ficus.git\ncd ./Ficus/\nyarn install\nyarn electron:serve\n```\n\n\n\n## 架构\n\n项目的架构图如图所示\n\n\u003cp align = \"center\"\u003e\n\u003cimg src=\"https://github.com/Thysrael/Ficus/assets/72613958/71ae0189-964d-429c-8715-7bb4b8dd381a\" /\u003e\n\u003c/p\u003e\n\n项目目录架构如下：\n\n```\n├── build: 构建需要的资源\n├── public: 美工样式资源\n│   └── css\n│       └── content-theme\n├── src: 项目源码\n│   ├── common: 公用资源\n│   ├── IR: FicIR \n│   │   ├── block: IR 基本数据结构\n│   │   │   ├── base \n│   │   │   │   ├── content: 节点信息\n│   │   │   │   ├── linkedList\n│   │   │   │   └── type: 类型\n│   │   │   └── factory: 工厂方法\n│   │   ├── component: IR 顶层数据结构\n│   │   ├── history: 历史记录\n│   │   ├── manager: 数据管理器，对外唯一接口\n│   │   └── utils: 外部工具\n│   │       └── marked: markdown 词法解析器\n│   ├── main: electron 后端\n│   │   ├── filesystem: 文件操作方法\n│   │   ├── helper: 工具方法\n│   │   └── update: 打包方法\n│   └── renderer: Vue 前端\n│       ├── assets: 前端静态资源\n│       ├── components: vue 组件\n│       │   ├── header: 顶栏\n│       │   ├── mindEditor: Ficus 模式编辑器\n│       │   │   └── assets\n│       │   ├── richTextEditor: 富文本编辑器\n│       │   ├── sideBar: 侧边栏\n│       │   └── textArea: 文本编辑器\n│       ├── store: 存储\n│       └── utils\n│           └── keyboardbinding: 快捷键绑定\n└── test: 单元测试\n    ├── IR: IR 测试\n    │   ├── data\n    │   ├── factory\n    │   └── manager\n    └── main: 主进程方法测试\n        ├── data\n        └── filesystem\n```\n\n我们改写的软件包仓库如下：\n\n- [ficus-editor](https://github.com/Hyggge/ficus-editor)\n- [lute-for-ficus](https://github.com/Dofingert/lute-for-ficus)\n- [vue3-mindmap](https://github.com/GwokHiujin/vue3-mindmap)\n\n\n\n## 更新日志\n\n### v0.1.0\n\n**发布时间**：2023.04.26\n\n**简介**：alpha 版本发布。\n\n**功能速览**：\n\n- 所见即所得的 markdown 编辑\n- 打开文件，打开文件夹\n- 基础框架搭建\n- 热更新\n- 支持榕树功能，只支持榕图的展示功能，不支持榕图的编辑功能，完全不支持榕林功能\n- 请不要随意用 ficus 打开重要文件，因为此版本存在一定风险清空用户的文件\n\n### v0.1.3\n\n**发布时间**：2023.05.07\n\n**简介：**alpha 版本的完善版本。\n\n**功能速览：**\n\n- 新的榕功能插件\n- 数学公式补全\n- 用户反馈 bug 修复\n\n### v0.1.8\n\n**发布时间：**2023.06.05\n\n**简介：** beta 版本的先行版本\n\n**功能速览：**\n\n- 榕功能完全开发完成\n- 编辑悬浮框\n- 搜索替换\n- 偏好设置\n- 快捷键\n- 图片复制粘贴\n- 需要进行进一步的美工润色、启动界面绘制和用户体验改进后发布 beta 最终版本\n\n### v0.1.9\n\n**发布时间：**2023.06.08\n\n**简介：** beta 版本的先行版本2\n\n**功能速览：**\n\n- 根据用户反馈，对 bug 进行修正\n\n### v0.2.0\n\n**发布时间：**2023.06.13\n\n**简介：** beta 版本发布。\n\n**功能速览：**\n\n- 根据用户反馈，对 bug 进行修正\n\n## 贡献\n\n如果您对我们的项目感兴趣，请随时加入！[提出一个 issue](https://github.com/Thysrael/Ficus/issues/new) 或者提交 PR。\n\n对于具体的贡献或者支持我们的方式，可以参考[这里](https://ficus.world/pages/87ba98/)。\n\n\n\n## 团队\n\n\u003cp align = \"center\"\u003e\n\u003cimg src=\"https://github.com/Thysrael/Ficus/assets/72613958/77105ff0-c34e-4807-bbf5-2216dab57dfc\" width=\"450px\" /\u003e\n\u003c/p\u003e\n\ngg=G 是由北京航空航天大学 2020 级计算机系 7 人组成的软件工程团队，这是我们的[团队博客](https://blog.csdn.net/gg_equal_G)。\n\n\n\n## License\n\n[MIT](LICENSE) © gg=G\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthysrael%2Fficus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthysrael%2Fficus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthysrael%2Fficus/lists"}