# flutter_markra

**Repository Path**: wangyidao/flutter_markra

## Basic Information

- **Project Name**: flutter_markra
- **Description**: flutter复刻https://github.com/markrahq/markra
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-14
- **Last Updated**: 2026-07-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Flutter Markra

基于 Flutter 重写的 **Markdown 笔记应用**，使用本地文件作为工作区，支持沉浸式编辑、实时预览、主题切换与全文搜索。

## 功能特性

- **本地文件工作区**：直接以 `.md` 文件 + `.markra/meta.json` 存储，笔记即文件，可随意用其他工具打开。
- **文件夹 / 笔记管理**：左侧树形结构，支持新建、重命名、删除、移动文件夹与笔记。
- **沉浸式编辑器**：内容左对齐、可调写作宽度 / 字号 / 行高，输入自动保存。
- **三种视图模式**：编辑 / 预览 / 分屏，可随时切换。
- **Markdown 预览**：基于 `flutter_markdown` 的实时渲染。
- **富插入能力**：插入图片（本地资源）、插入双链 `[[笔记标题]]`、大纲跳转。
- **全文搜索**：按标题或内容检索，结果在侧栏搜索框下方展示，点击即打开。
- **明 / 暗主题**：一键切换，侧栏与编辑区同步适配。
- **跨平台**：Windows / macOS / Linux / Android / iOS / Web。

## 快速开始

环境要求：Flutter 3.19+ 与 Dart 3.4+。

```bash
flutter pub get
flutter run
```

构建桌面端（以 Windows 为例）：

```bash
flutter build windows
```

## 应用图标

图标由 `tool/gen_icon.dart` 以代码绘制（圆角渐变底 + 文档卡片），再经 `flutter_launcher_icons` 生成各平台资源：

```bash
dart run tool/gen_icon.dart        # 生成源图 assets/icon/app_icon.png
dart run flutter_launcher_icons    # 生成 Android / iOS / Windows / macOS / Web 图标
```

如需调整配色或版式，修改 `tool/gen_icon.dart` 顶部的颜色常量后重新执行上述两条命令即可。

## 目录结构（核心）

```
lib/
  main.dart                 # 启动、展开默认文件夹、注入 Provider
  pages/home_page.dart      # 主界面：侧栏 + 编辑区 + 顶部工具栏
  widgets/
    md_editor.dart          # Markdown 编辑器
    md_preview.dart         # Markdown 预览
    tree/file_tree.dart     # 左侧文件夹 / 笔记树
    common/search_bar.dart  # 搜索框
  core/
    workspace/workspace.dart# 文件工作区读写
    db/                     # 笔记 / 文件夹模型与仓储
  providers/                # Riverpod 状态管理
```

## 许可证

详见项目内部约定。