Skip to content

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

License

Notifications You must be signed in to change notification settings

andreoliwa/logseq-doctor

Repository files navigation

Overview

docs Documentation Status
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

Use --help to check the current commands and options.

Example output:

$ lsd --help
Usage: lsd [OPTIONS] COMMAND [ARGS]...

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

Options:
  --help  Show this message and exit.

Commands:
  outline  Convert flat Markdown to outline.

$ lsd outline --help
Usage: lsd outline [OPTIONS] FILE

  Convert flat Markdown to outline.

Options:
  --help  Show this message and exit.

Documentation

https://logseq-doctor.readthedocs.io/

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