Doorstop Edit

A cross-platform GUI editor for Doorstop powered by PySide6 (Qt).

The goal of this GUI is to provide all the tools needed to efficiently work with a larger set of requirements within the editor. The editor use the doorstop API whenever possible to behave the same way as doorstop.

Features:

• Resizable and movable modern views for custom layout.
• Dark theme.
• Item tree with status colors and search function for good overview and fast location.
• Live markdown-HTML rendering.
• Section or single mode reading.
• Review and clear suspect links.
• Edit additional attributes with boolean and string types.
• Built-in item diff tool to review changes made on disk.
• Markdown formatting tool powered by mdformat for the text attribute.
• Pin feature for easy access to work-in-progress items.
• And more...

TODO list:

• Add and remove document.
• Validating documents and items in a user-friendly manner.

Install

Automatic install with pip:

pip install doorstop-edit

For source installation see Contributing section.

Demo/Testing

There is a python script that generates a document tree which can be useful when testing this application.

python3 tools/gen_sample_tree.py

# Output will be located in the dist/ folder.

Other doorstop GUI's

There exists at least two well known GUI's for doorstop editing, doorhole and the build-in GUI in doorstop.

Contributing

See CONTRIBUTING.md.