Skip to content

GordonZhang2024/tkMarker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

logo tkMarker

A light weight Markdown editor

Static Badge

GitHub Actions Workflow Status GitHub forks GitHub Repo stars GitHub watchers

website

🚀 Features

  • Markdown preview
  • Basic markdown syntax support
  • GitHub flavored Markdown support (beta)
  • Auto refresh
  • It's really fast!
  • Code highlight
  • Auto complete

screenshot

Installation

Installing the dependencies

GNU/Linux

This project requires Tkinter. To install it, type command:

$ sudo apt-get install python-tk # On Debian based GNU/Linux distributions
$ sudo dnf install python3-tkinter # On Fedora based GNU/Linux distributions

Installing tkMarker

GNU/Linux

First, you need to download a release and extract the source tarball. Then, type command:

$ pip install -r requiremonts.txt
$ ./install.sh

Important

Please use Python >= 3.8

Creating desktop icon

Write this to ~/.local/share/applications/tkmarker.desktop

[Desktop Entry]
Name=tkMarker
Exec=/home/<your-user-name>/.local/bin/tkmarker
Type=Application
Icon=<path/to/tkMarker>/static/tkMarker.png
Categories=Development;
Keywords=Markdown;

Usage

Type command:

$ tkmarker &

You will see the editor.

Click the Preview Button, then the editor will open the preview in the web browser.

License

MIT License


Give it a try! I know you'll like it.


This is a software with ABSOLUTELY NO WARRANTY.

Feel free to report an issue. You are welcomed to start a pull request.