https://github.com/xqtr/markln
A MarkDown editor, with live preview, for use in the Terminal
https://github.com/xqtr/markln
Last synced: 5 months ago
JSON representation
A MarkDown editor, with live preview, for use in the Terminal
- Host: GitHub
- URL: https://github.com/xqtr/markln
- Owner: xqtr
- License: gpl-3.0
- Created: 2025-10-05T15:32:44.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-10-05T15:44:53.000Z (8 months ago)
- Last Synced: 2025-10-05T17:40:32.746Z (8 months ago)
- Language: Python
- Homepage: https://cp737.net/blog/markln-markdown-editor-for-the-terminal
- Size: 24.4 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tuis - markln - based markdown editor built with Textual. (Table of Contents)
README
# MarkLn v1.2
A terminal-based markdown editor built with Textual (Python TUI framework)
### DESCRIPTION
A feature-rich markdown editor that runs in the terminal with real-time preview. Edit markdown files with instant rendering in a split-pane interface. Perfect for quick editing without leaving the command line.
### FEATURES
- Dual-pane interface: Edit markdown with live preview
- Toggle between views (Synced, Editor, Preview)
- Table of contents, dynamically created
- Tags selector to insert easily markdown tags (F3)
- File management: Open, save, and save-as functionality
- Keyboard-driven: Fully operable with keyboard shortcuts
- Full mouse support also
- Theme support
- Comprehensive help: Built-in markdown syntax reference
- Editor supports common key shortcuts for copy/paste/undo - ctrl-c, ctrl-x, ctrl-w
- Support for terminal shortcuts like ctrl-w and others
- Resize on the fly
- Syntax Highlighting
### INSTALLATION
#### Prerequisites:
- Python 3.8 or higher
- pip package manager
**Steps:**
Clone the repository:
`git clone `
`cd markln`
**Install requirements:**
`pip install -r requirements.txt`
**Run the editor:**
`python markln.py`
### USAGE
Keyboard shortcuts:
- Tab: Switch between controls
- Ctrl+O: Open file
- Ctrl+S: Save file
- Ctrl+Shift+S: Save as
- Ctrl+T: Toggle editor/preview
- Ctrl+L: Show help
- Ctrl+N: New file
- Ctrl+R: Toggle Wrap
- Ctrl+J: Sync Editor with Preview
- Ctrl+G: Dialog box to insert Markdown Tags
- Ctrl+Q: Quit
- Ctrl+\: Options Menu
- Ctrl+Home: Go to document start
- Ctrl+End: Go to document end
### SUPPORTED MARKDOWN
- Headers (#, ##, ###)
- Bold and italic text
- Lists (ordered and unordered)
- Code blocks and inline code
- Links and images
- Blockquotes
- Tables
- Horizontal rules
### DEPENDENCIES
- Python standard library
- Textual - TUI framework
- PyperClip
### SHOWCASE
### LICENSE
GPL-3.0-or-later
### SUPPORT
For issues and questions, please check the issues page or create a new issue with detailed description.
This editor is designed for developers who prefer working in the terminal and need a quick, efficient way to edit markdown files with instant visual feedback.
### CHANGELOG
**1.1**
- When text is changed and try to quit or create a new file, now a Save dialog appears.
- Minor bugs and code optimization.
**1.2**
- Added feature to show/hide TOC
- Added Options dialog, with functions
- Colorized the statusbar
- When in full editor mode, the markdown preview doesn't update, so makes typing quicker and responsive
- Added the option to stop continues rendering of Markdown on the preview, to make typing more responsive. You can Update the preview, from the options menu
- The app. now has a config file to save default values, like theme, last file, window mode
- You can specify in which mode you want the app to open at start, with the "window_mode" value of the config file. The values it accepts are: split, preview, editor
- Added support for installing external themes. Specify the folder of the themes and the name of the theme file to load a new one.
- When exiting the program, the current theme will be saved and applied next time you run it again
- Three new themes provided: Arctic, Turbo Pascal, MSDOS