Skip to content
duxlabs-devPublic

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Repository files navigation

Dux Edit

Dux Edit

A text and document editor for the dux desktop

Built with dux-qt-base and Go

GitHub License Discord Ko-Fi donate

Dux Edit opens any text file without a project around it: notes, config files, scripts, Markdown. It sits between a scratchpad and an IDE, and takes over from the DMS notepad.

  • Tabs, drafts that survive a restart, and crash recovery
  • Syntax highlighting with Chroma, colored from the desktop theme
  • Markdown preview, spellcheck, find and replace with regular expressions
  • Keeps encodings and line endings as they are, and saves root-owned files through polkit
  • Simple and Advanced modes

Dux Edit is a Go binary that carries its own QML UI and runs it on dux-qt-base.

Build and run

You need Go and dux-qt-base 0.4.3 or newer (the dux-qt-base package, libdux-qt-base0 on Debian and Ubuntu). Spellcheck uses hunspell and its dictionaries when they are installed.

git clone --recurse-submodules https://github.com/duxlabs-dev/dux-edit.git
cd dux-edit
make run

make run makes a build without the embedded UI and loads quickshell/ straight from the repo, with hot reload.

make
sudo make install

make builds core/bin/dux-edit with the UI embedded. make install puts the binary, the dedit alias, the desktop entry and the icon under /usr/local. make QTBASE=1 also builds dux-qt-base from the submodule and embeds it.

Using it

dux-edit                          # show the window, start the app first if it is not running
dux-edit notes.md todo.txt        # open files as tabs in the running app
dux-edit main.go --line 42 --column 7
dux-edit --simple notes.md        # Simple mode
dux-edit --new-instance           # a separate app instead of tabs in the running one
dux-edit run -d                   # run in the background
dux-edit ipc describe             # every socket method
dux-edit kill

A file named like a command (run, kill, ipc, qs, version, help, ...) needs a path: dux-edit ./run.

Where things live

Path What
~/.config/dux/edit/settings.json Settings
~/.config/dux/edit/custom_dictionary.txt Words added to the spellcheck dictionary, one per line
~/.config/dux/edit/plugins/ Plugins
~/.local/state/dux/edit/session.json Open tabs (never their text)
~/.local/state/dux/edit/swap/ Drafts and unsaved changes

License

MIT

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages