andreoliwa/logseq-doctor

来源：https://github.com/andreoliwa/logseq-doctor

Logseq Doctor

文档 (https://andreoliwa.github.io/logseq-doctor/) Go 构建状态 (https://github.com/andreoliwa/logseq-doctor/actions) Tox 构建状态 (https://github.com/andreoliwa/logseq-doctor/actions) 覆盖率状态 (https://codecov.io/github/andreoliwa/logseq-doctor) PyPI 包 (https://pypi.org/project/logseq-doctor)

Logseq Doctor：在将老版扁平 Markdown 文件导入 Logseq 之前，先对其进行修复。

📚 阅读完整文档 (https://andreoliwa.github.io/logseq-doctor/)

本项目仍处于 alpha 阶段，各方面（文档和功能）都还比较粗糙。

目前同时提供 Python 和 Go 两种 CLI。

长期计划是将其转换为 Go，并逐步移除 Python。 新功能将仅添加到 Go CLI 中。

什么是 Logseq Doctor？

Logseq Doctor 是一个命令行工具，提供各种命令来操作您的 Logseq (https://logseq.com/) Markdown 文件。它提供了以下实用功能：

• 将扁平 Markdown 转换为 Logseq 的大纲格式
• 向页面和日志追加内容
• 创建便于在移动应用中查看和优先级排序的任务积压
• 在 Logseq 中管理任务
• 清理和整理 Markdown 文件
• 防止提交无效内容
• 更多功能即将推出……

功能

• 积压管理（backlog）：将来自多个页面的任务聚合成统一的积压列表，支持智能分类、逾期检测和焦点页面生成
• 内容管理（content）：向 Logseq 页面或日志追加原始 Markdown 内容
• Markdown 集成（md）：通过 DOM 操作解析并添加 Markdown 内容，支持父级块和日志定位
• 任务管理（task add）：基于键值搜索添加新任务或更新现有任务，同时保留子任务和属性
• 整理（tidy-up）：清理并标准化您的 Markdown 文件
• 高性能：使用 Go 编写，速度快、效率高
• 大纲转换（outline）：将扁平 Markdown 文件转换为 Logseq 的大纲格式
• 任务列表（tasks）：列出并管理 Logseq 图谱中的任务

安装

Go 二进制可执行文件

macOS 和 Linux 推荐使用 Homebrew 安装：

brew install andreoliwa/formulae/logseq-doctor

或者手动安装：

go install github.com/andreoliwa/logseq-doctor/cmd/lqd@latest

确认它是否在路径中：

which lqd
# 或
ls -l $(go env GOPATH)/bin/lqd

Python 可执行文件

推荐使用 pipx (https://github.com/pypa/pipx) 全局安装 logseq-doctor：

pipx install logseq-doctor

您也可以使用以下命令安装开发版本：

pipx install git+https://github.com/andreoliwa/logseq-doctor

之后，系统全局将拥有 lqdpy 命令。

从源码构建

要从源码构建并安装（Python 和 Go 可执行文件均会生成），请克隆仓库并运行：

make install

快速开始

输入 lqd（Go 可执行文件）不带参数，查看当前命令和选项：

Logseq Doctor heals your Markdown files for Logseq.

Convert flat Markdown to Logseq outline, clean up Markdown,
prevent invalid content, and more stuff to come.

"lqdpy" is the CLI tool originally written in Python; "lqd" is the Go version.
The intention is to slowly convert everything to Go.

用法：
lqd [命令]

可用命令：
backlog     将多个页面的任务聚合成统一的积压列表
completion  为指定 shell 生成自动补全脚本
content     向 Logseq 追加原始 Markdown 内容
help        查看任意命令的帮助信息
md          通过 DOM 操作向 Logseq 添加 Markdown 内容
task        管理 Logseq 中的任务（子命令：add）
tidy-up     整理 Markdown 文件

标志：
-h, --help   lqd 帮助

使用 "lqd [命令] --help" 获取有关某个命令的更多信息。

输入 lqdpy 不带参数，查看当前命令和选项：

用法：lqdpy [选项] 命令 [参数]...

Logseq Doctor：在导入前修复您老旧的扁平 Markdown 文件。

选项：
-g, --graph 目录                 Logseq 图谱  [环境变量：LOGSEQ_GRAPH_PATH;
必需]
--install-completion [bash|zsh|fish|powershell|pwsh]
为指定的 shell 安装补全功能。
--show-completion [bash|zsh|fish|powershell|pwsh]
显示指定 shell 的补全功能，以便
复制或自定义安装。
--help                          显示此消息并退出。

命令：
outline  将扁平 Markdown 转换为大纲。
tasks    列出 Logseq 中的任务。

开发

设置本地开发环境：

make setup

运行此命令查看所有可用目标的帮助：

make

运行所有测试：

tox

注意，要合并来自所有 tox 环境的覆盖率数据，请运行：