Skip to content

Latest commit

 

History

History
93 lines (59 loc) · 2.18 KB

README.md

File metadata and controls

93 lines (59 loc) · 2.18 KB

noted Logo

noted

a simple light markdown editor written in Python and PyQT5. PyQT is a library that is used to build GUI applications in Python using the Qt GUI framework.


About

noted is a light-weight, distraction free Markdown editor. It uses the QTextEdit class in PyQT5 to render basic Markdown syntax.

What is Markdown?
Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents.


Features

  • Live preview with a clean and simple interface for distraction-free writing experience.
  • Save files in Markdown file format (*md).
  • Supports GitHub Flavoured Markdown Spec.
  • Themes: Light Mode & Dark Mode.
  • Translucency effect


💡**Themes**

Light Mode Dark Mode

Getting Started

Dependencies

  • Python 3.8 +
  • PyQT5

Installation

! note: noted will only run with PyQT5 version of PyQT


Running noted

  • Clone this repository
$ git clone  https://github.com/tanthehack/noted
  • Switch to the newly created directory
$ cd ./noted
  • Run the main.py file
$ python main.py
  • Wait for the app to start up and then you can write to thy hearts content! :)




From Tanya to You ;) -->

Hope you enjoy using noted! I worked REALLY hard on it. Working with PyQT5 without using a Designer is tough but I made it work.

I will in the future try to implement:

  • Open existing md files and edit them in noted.
  • Adding WYSIWYG features.
  • Spell checking
  • Improved Markdown rendering.
  • Improve translucency effect
  • More THEMES! :)

Version History

  • 1.0
    • Initial release

License

This project is licensed under the MIT License, more details here.