This is a simple AI integrated Markdown generator implemented in Python using the Tkinter library for the graphical user interface and the tkhtmlview
, replicate
, and markdown2
libraries for HTML rendering, text generation, and Markdown conversion, respectively.
To use this Markdown generator, you need to have Python installed on your system.
-
Clone the repository or download the source code:
git clone https://github.com/gargimittal/ReadMe-generator.git
-
Navigate to the project directory:
cd ReadMe-generator
-
Install the required Python packages:
pip install markdown2 pip install replicate
-
Run the Markdown generator:
python mdGenrator.py
-
Markdown Input: Enter your Markdown content in the left pane using the provided ScrolledText widget.
-
HTML Output: View the HTML-rendered output in the right pane using the HTMLScrolledText widget.
-
Generate Responses: Generate Markdown content using the provided API key and prompt. Click the "Generate" button to fetch responses based on the specified settings.
-
Save File: Save the entered Markdown content to a file by clicking on "File" in the menu and selecting "Save."
-
About: Learn more about the Markdown editor by clicking on "Help" in the menu and selecting "About."
-
Enter your API key and prompt in the designated input fields.
-
Click the "Generate" button to populate the Markdown pane with responses based on the provided API key and prompt.
-
Input your Markdown content or make changes in the left pane.
-
Save your Markdown content by selecting "File" and then "Save" from the menu.
Feel free to contribute to the development of this Markdown generator by submitting issues or pull requests. Your feedback and contributions are highly appreciated.
- This project utilizes the Tkinter, tkhtmlview, replicate, and markdown2 libraries.
- Special thanks to the developers of replicate for providing the API used for text generation.
Note: Make sure to keep your API key secure and do not share it publicly. The API key is sensitive information and should be handled with care.