Quark Note Taker

Quark Note Taker (or just Quark for short) is an opensource, cross platform, Markdown-based note taking application written in Python. All notes are stored as plain-text/markdown files. It has a build-in live preview of the notes with MathJax support and the note editor provides built-in spell checking. The user interface is made with the PyQt framework.

Current features

• note editor with markdown pretty-printing (syntax highlighting)
• in-editor spellchecking
• basic note management
• auto-saving
• markdown live preview
• pretty-printing of code blocks
• MathJax support
• synchronized scrolling

Dependencies

• Python 3.x.x
• PyQt5
• Misaka
• Pygments
• PyEnchant

Note: In the past, Quark used the Python Markdown module to generate the live preview of notes. It now uses the Misaka module instead as it provides better performance.

Quick start guide

1. Make sure you have all dependencies installed and that they all work correctly.
2. Clone Quark and its submodules using: git clone --recursive https://github.com/Leonardo2718/Quark_Note_Taker.git.
3. Start Quark by running the file quark.py.
4. Quark will prompt you to create a notes directory. By default, it will be $HOME/QuarkNotes/ but this can be changed in the settings.py file. Once the notes directory is created, Quark will ask you if you want to put a copy of this README file and other documentation in this new directory.
5. When Quark starts, if README.md is not opened by default, use File->Open (or type Ctrl+O) to open the file/note.
6. If the file opens and is displayed correctly, then Quark is working!
7. Optional: customize Quark to your liking by modifying any of the following files
   • config.json
   • themes/default.css
   • html-template/htmlDoc_start.html
   • html-template/htmlDoc_end.html
   • some or all source files

Known issues

1. There is a problem highlighting the syntax of nested emphasis when the same symbols are used such as _emphasized __and__ strong_ so use _emphasized **and** strong_ instead if care about correct syntax highlighting.

Note: Quark Note Taker has only been tested on Linux platforms

License

Quark Note Taker is licensed under the MIT License.

All documentation that goes with Quark Note Taker is licensed under a Creative Commons Attribution 4.0 International License.