pymd-editor 0.0.4

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
     • Install With PIP
     • Install From Source
   • Usage
     • Standalone
     • Embedded
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

A standalone and embeddable Python based Markdown editor with HTML preview.

(back to top)

Built With

• Pygments
• Python
• Python Markdown
• tkinter
• tkinterweb
• ttkbootstrap

(back to top)

Getting Started

Installation

To get a local copy up and running choose one of the below install instructions and follow the steps provided.

Install With PIP

The simplest way to install the PyMD Editor is to use pip:

pip install pymd-editor

Install From Source

Alternatively you can install from source by following the steps below:

1. Clone the repo:

   git clone https://github.com/hreikin/pymd-editor.git
   cd pymd-editor/
   

2. Create and source a Python virtual environment:

   python3 -m venv .venv
   source .venv/bin/activate
   

3. Install requirements with pip:

   pip install -r requirements.txt
   

(back to top)

Usage

Standalone

To start the standalone editor simply run the following:

python3 -m pymd_editor

(back to top)

Embedded

To use the ttkbootstrap styled EditorFrame in one of your own python scripts:

from pymd_editor.pymd_editor_frame import EditorFrame

import tkinter as tk
import ttkbootstrap as ttk
from ttkbootstrap.constants import *

root = ttk.Window(themename="darkly")
app = EditorFrame(root)
app.pack(fill="both", expand=1)
app.mainloop()

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Github Link: https://github.com/hreikin/pymd-editor
PyPi Link: https://pypi.org/project/pymd-editor/
Documentation: https://hreikin.github.io/pymd-editor/

(back to top)