Skip to content

dcervenkov/markdown-diary

Repository files navigation

arkdown Diary

Build Status codecov.io Code Coverage

A simple Markdown note taking application.

Installation

You need python3 with the following libraries:

  • pyqt5 Qt5 and its Python bindings
  • pyqtwebengine Qt5 web renderer and its Python bindings
  • mistune Markdown parser
  • pygments syntax highlighter

You can install them easily using pip3

pip3 install pyqt5 pyqtwebengine pygments mistune

Desktop Integration

You may want to add Markdown Diary to your application menu and/or add an icon for it. A sample .desktop file and icon are provided in the resources folder.

Desktop File

  • Change the Path entry in the .desktop file
  • Put it in the proper place (probably ~/.local/share/applications or /usr/share/applications)

Icon

  • Copy icon to where your theme's icons are (probably ~/.icons/<theme name>/apps/scalable or /usr/share/icons/<theme name>/apps/scalable).

Known Issues

  • PyQt 5.10 crashes, printing 'Could not find QtWebEngineProcess' and a stack trace. Apparently others have encountered a similar problem. PyQt 5.11 or newer doesn't have the issue. If you can't use newer PyQt, you can downgrade PyQt (e.g., pip3 install pyqt5<5.10).
  • Since PyQt 5.12, QtWebEngine was moved out of the pyqt5 package into pyqtwebengine (see here). If you are using PyQt 5.11 or lower, there is no need to install pyqtwebengine.