tusk-editor 0.1.1

A modern terminal-based Markdown editor

Tusk

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

Table of Contents

• Tusk
  • Table of Contents
  • Features
  • Installation
    • Via pip
    • From source
  • Usage
    • Key Bindings
  • Contributing
  • 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+P: Open command palette
• Ctrl+B: Toggle sidebar
• Ctrl+L: Expand input-box
• Ctrl+Q: Shrink input-box

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.