Skip to main content

A modern terminal-based Markdown editor with Git integration

Project description

Tusk

A modern terminal-based Markdown editor with real-time preview and Git integration.

Version Python License

Features

  • Real-time Markdown preview
  • Auto-completion for Markdown syntax
  • Auto-save functionality
  • Multiple theme support
  • Adjustable split-view layout
  • Table of Contents generation
  • Export to HTML, PDF, and DOCX
  • Command palette

Installation

Via pip

pip install tusk-editor

From source

git clone https://github.com/vedant-asati03/tusk.git
cd tusk
pip install -e .

Usage

To start the editor:

tusk filename.md

Key Bindings

  • Ctrl+S: Save file
  • Ctrl+Q: Quit
  • Ctrl+P: Open command palette
  • Ctrl+B: Toggle sidebar
  • Ctrl+/: Toggle preview

Contributing

Feel free to contribute by forking the repo and submitting a pull request! 🚀

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tusk_editor-0.1.0.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tusk_editor-0.1.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file tusk_editor-0.1.0.tar.gz.

File metadata

  • Download URL: tusk_editor-0.1.0.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.0

File hashes

Hashes for tusk_editor-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a11a5c6e66ac0afd29570656b16f327822b60ecf616239c7b3809e954500581b
MD5 aa4f7eb0d0be87220f90de4a8adcaa00
BLAKE2b-256 a86e9c0335bc6d82b1be789a9ff441219ca2f8173e99a6a416ae6f839e7ba0fa

See more details on using hashes here.

File details

Details for the file tusk_editor-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: tusk_editor-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.0

File hashes

Hashes for tusk_editor-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 626fbd3a56844115c194e6f70ea928c453f70b2c36c90a0be23f4da4186b2b8c
MD5 2a53f625554e80e8fbead3c0ef909f1a
BLAKE2b-256 2621a5bf7459712105523ebfd174454158cf47f34991865c304552609a003960

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page