Skip to content
This repository has been archived by the owner on May 6, 2022. It is now read-only.

Patitotective/QMarkdownPreviewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QMarkdownPreviewer

A simple but useful markdown previewer with live update.

Usage

Download QMarkdownPreviewer.py and github_markdown_style.py. You can fit them into a folder but make sure to keep them together.
Then on the script you want to use the markdown previewer:

  1. Import it:
from QMarkdownPreviewer import MarkdownPreviewer
  1. To use it is quite simple:
markdown_previewer = MarkdownPreviewer(path)
markdown_previewer.show()

Where path is the path of the file to preview.

Example

If you want to see an example, run QMarkdownPreviewer itself.

Preview example

Another implementation

PyAPIReference uses a similar code of this markdown highlighter to do this. PyAPIRefernece GIF example
See https://github.com/Patitotective/PyAPIReference/blob/main/PyAPIReference/GUI/markdown_previewer.py

About

Patitotective:

About

A live markdown previewer for PyQt5.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages