https://github.com/olivermao/node-mark

https://github.com/olivermao/node-mark

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/olivermao/node-mark
• Owner: OliverMao
• Created: 2024-11-20T14:49:03.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-20T14:58:58.000Z (2 months ago)
• Last Synced: 2024-11-20T16:18:43.492Z (2 months ago)
• Language: CSS
• Size: 316 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        






 📦 node-mark - 散点Markdown文档阅读器





  

  

  





# Node Mark - 散点Markdown文档阅读器

Node Mark是一个轻量级的本地Markdown文档阅读器,支持分组管理和实时预览功能。

## 主要特性

- 🗂️ 文件夹分组管理

- 🔍 文件搜索功能

- 🌓 明暗主题切换

- 📱 响应式设计

- 🖼️ 图片预览支持

- 💻 系统托盘运行

- 🔄 实时刷新

## 安装

1. 确保已安装Python 3.8+

2. 克隆项目并安装依赖:

```bash

git clone https://github.com/yourusername/node-mark.git

cd node-mark

pip install -r requirements.txt

```

## 配置

在`config.yaml`中配置你的Markdown文件路径:

```yaml

folders:

  工作文档:

    - path: "D:/documents/work/*.md"

  个人笔记:

    - path: "D:/notes/*.md"

    - path: "D:/blog/posts/*.md"

      alias: "博客文章"

```

配置说明:

- 支持文件夹分组

- 支持通配符`*.md`

- 可以为文件设置别名

## 运行

### 方式一: 直接运行

```bash

python app.py

```

### 方式二: 后台运行(Windows)

双击`启动笔记.vbs`即可在后台运行。

## 使用说明

1. 启动后会在系统托盘显示图标

2. 点击托盘图标可以打开主界面

3. 在主界面可以:

   - 查看所有分组的Markdown文件

   - 搜索文件

   - 切换主题

   - 查看文件详细信息

## 技术栈

- 后端: Flask

- 前端: 原生HTML/CSS/JS

- UI: Remix Icon

- Markdown渲染: mistune

- 系统托盘: pystray

## 许可证

MIT License