omarmir/nanote

Nanote

镜像概述和主要用途

Nanote是一个轻量级自托管笔记应用，基于文件系统存储，使用Nuxt 3、TypeScript构建，专注于简单性和性能。其核心目标是实现100%可移植的笔记管理，无需数据库，仅通过文件夹和文件组织内容，用户可直接通过终端、记事本或其他工具编辑笔记。

核心功能和特性

主要功能

• 📂 基于笔记本的组织 - 文件夹作为笔记本，Markdown文件作为笔记
• 🔍 全局搜索 - 跨所有笔记的快速内容搜索（系统优化）
• 📄 Markdown支持 - 原生.md文件处理，带有正确的MIME类型
• 🔒 本地存储 - 无数据库依赖，直接使用文件系统存储
• 🐳 Docker支持 - 完整容器化支持，提供示例compose配置
• 🔧 类型安全API - 全类型化REST端点，包含请求验证
• 🚀 性能优化 - 优化的文件操作和平台特定搜索功能
• 📱 移动友好 - 适配移动设备的布局，支持移动端查看和编辑

自定义Remark指令

在笔记中输入特定命令可触发UI交互：

• ::file - 创建内联文件选择器，支持文件上传（需配置上传路径）
• ::fileBlock - 创建整行文件块选择器，支持文件上传（需配置上传路径）
• ::today - 插入当前日期
• ::now - 插入当前日期和时间
• ::tomorrow - 插入明天日期
• ::yesterday - 插入昨天日期

待办功能

• 归档系统 - 笔记和笔记本归档功能
• 清单汇总 - 跨笔记汇总清单项目，优化任务管理
• 加密功能 - 笔记/笔记本静态加密
• 多端应用 - 移动/桌面应用（计划通过PWA实现）

使用场景和适用范围

• 适合需要自托管解决方案、追求数据完全控制权的用户
• 偏好通过文件系统管理内容，希望直接编辑文件的用户
• 需要轻量级、无数据库依赖的个人笔记工具的开发者或学生
• 需跨设备同步笔记（可配合文件同步工具实现）的场景

使用方法和配置说明

Docker部署

获取镜像

可直接使用官方镜像：

bash
omarmir/nanote

或克隆仓库构建本地镜像：

bash
git clone https://github.com/omarmir/nanote.git
cd nanote
docker build -t nanote .

docker-compose配置

创建docker-compose.yml文件，配置环境变量和存储卷：

yaml
version: '3'
services:
  nanote:
    image: omarmir/nanote  # 或使用本地构建镜像: nanote
    environment:
      - NOTES_PATH=/notes       # 容器内笔记存储路径
      - UPLOAD_PATH=/uploads    # 容器内附件存储路径
      - SECRET_KEY=<yourkey>    # 安全密钥，建议自定义
    volumes:
      - /path/to/local/notes:/notes    # 本地笔记文件夹挂载
      - /path/to/local/uploads:/uploads # 本地附件文件夹挂载
    ports:
      - "3000:3000"  # 默认端口映射

环境变量说明

注意：若未配置卷挂载，笔记和附件将保存在容器内部，容器删除后数据会丢失。

启动服务

bash
docker compose up -d

服务启动后，通过http://localhost:3000访问应用。

技术栈说明

• 前端框架：Nuxt 3 和 Vue
• 状态管理：Pinia
• 样式框架：Tailwind CSS 3
• 编辑器组件：Milkdown

安全说明

默认安全密钥为nanote，生产环境中必须通过SECRET_KEY环境变量设置自定义密钥，以确保应用安全性。