andreoliwa / logseq-doctor

Heal your Markdown files: convert to outline, list tasks and more tools to come

Overview

docs
tests
package

Logseq Doctor: heal your flat old Markdown files before importing them.

Note: this project is still alpha, so it's a bit rough on the edges (documentation and feature-wise).

Installation

The recommended way is to install logseq-doctor globally with pipx:

pipx install logseq-doctor

You can also install the development version with:

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

You will then have the lsd command available globally in your system.

Quick start

Type lsd without arguments to check the current commands and options:

 Usage: lsd [OPTIONS] COMMAND [ARGS]...

 Logseq Doctor: heal your flat old Markdown files before importing them.

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.      │
│ --show-completion             Show completion for the current shell, to copy │
│                               it or customize the installation.              │
│ --help                        Show this message and exit.                    │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ outline  Convert flat Markdown to outline.                                   │
│ tasks    List tasks in Logseq.                                               │
│ tidy-up  Tidy up your Markdown files by removing empty bullets in any block. │
╰──────────────────────────────────────────────────────────────────────────────╯

Development

To run all the tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows	set PYTEST_ADDOPTS=--cov-append tox
Other	PYTEST_ADDOPTS=--cov-append tox