Tasks.md

概述

Tasks.md 是一个自托管、基于 Markdown 文件的任务管理看板工具，通过文件系统组织任务和泳道，提供现代化的响应式界面，支持本地部署和个性化配置。

核心功能与特性

• 在现代化响应式界面中创建卡片、泳道和标签
• 以 Markdown 文件形式存储任务卡片
• 单Docker镜像简易安装
• 跟随操作系统设置自动切换明暗主题
• 高度可定制，内置3种默认颜色主题（Adwaita、Nord、Catppuccin）
• 支持基于子路径的反向代理，通过环境变量配置基础路径
• 可作为PWA（渐进式Web应用）安装

使用场景

适用于个人或团队的轻量级任务管理，尤其适合需要本地文件存储、Markdown编辑支持或与笔记工具（如Obsidian）联动的场景。

安装与使用

Docker 部署

执行以下命令启动容器：

bash
docker run -d \
  --name tasks.md \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TITLE="" \
  -e BASE_PATH="" \
  -e LOCAL_IMAGES_CLEANUP_INTERVAL=1440 \
  -p 8080:8080 \
  -v /本地路径/任务/:/tasks/ \
  -v /本地路径/配置/:/config/ \
  --restart unless-stopped \
  baldissaramatheus/tasks.md

参数说明（所有环境变量均为可选，建议保留PUID和PGID）：

• PUID/PGID: 拥有文件和目录的用户ID和组ID（Linux系统可通过id命令查看，默认通常为1000）。若不设置，文件将以root权限创建。
• TITLE: 显示在头部和浏览器标签的自定义名称
• BASE_PATH: URL基础路径，用于子路径反向代理场景
• LOCAL_IMAGES_CLEANUP_INTERVAL: 本地图片清理间隔（分钟），默认1440（24小时），设为0禁用清理

卷挂载说明：

• /tasks/: 存储任务Markdown文件和泳道目录
• /config/: 存储配置文件、样式表和主题

Docker Compose 配置

yaml
version: "3"
services:
  tasks.md:
    image: baldissaramatheus/tasks.md
    container_name: tasks.md
    environment:
      - PUID=1000
      - PGID=1000
    volumes:
      - /本地路径/任务:/tasks
      - /本地路径/配置:/config
    restart: unless-stopped
    ports:
      - 8080:8080

环境变量和卷配置参考上述Docker部署说明。

自定义配置

配置卷（/config/）下的stylesheets目录包含所有样式文件，建议将自定义样式添加到custom.css。内置3种颜色主题（Adwaita、Nord、Catppuccin）位于/stylesheets/color-themes目录，切换方法：

1. 编辑 /stylesheets/custom.css 的第一行，改为目标主题路径（如@import "color-themes/nord.css";）
2. 浏览器强制刷新（Ctrl+F5）应用更改

文件结构说明

任务和泳道通过文件系统直接映射：

• 泳道：对应文件系统中的目录
• 任务：对应目录中的Markdown文件

例如，界面中显示"Backlog"、"Sprint"、"Done"三个泳道，每个泳道下的任务对应相应目录中的Markdown文件。文件结构与界面展示完全一致，便于通过文件管理器或笔记工具直接管理。

技术栈

• 前端：SolidJS（高性能UI框架）
• 后端：Koa（轻量级Node.js web框架）
• 编辑器：Stacks-Editor（Markdown编辑组件）
• 静态资源：serve-static（样式文件服务）

贡献指南

Bug修复与功能请求

可提交issue报告bug或请求新功能，建议添加适当标签，并为关注的issue点赞以提升优先级。

开发贡献

1. 从现有issue中选择任务
2. 开发解决方案并提交PR
3. 若对实现方案不确定，可在相关issue中讨论或提交草稿PR