ReadMeX is a web-based markdown editor designed to help you create well-structured and professional-looking README.md files for your projects. It supports features like live preview, drag-and-drop markdown elements, and code syntax highlighting, making the process of creating a README.md easier and more efficient.
- About
- Features
- Live Demo
- Screenshots
- Getting Started
- Platforms Tested
- Usage
- Technology Stack
- Contributing
- Acknowledgments
- Bug Reporting
- License
- Code of Conduct
- Contact
- Drag-and-Drop Markdown Elements: Easily add sections like headers, lists, tables, and code blocks to your README with just a drag-and-drop interface.
- Live Markdown Preview: See real-time updates of your markdown in the live preview window.
- Code Blocks with Syntax Highlighting: Add code snippets with proper syntax highlighting.
- AJAX and WebSocket Support: Choose between real-time WebSocket connections for instant updates (ideal for localhost) or AJAX-based interactions (suitable for public hosting).
- Table and List Support: Supports the creation of tables and lists with markdown syntax.
- Block Alerts: Allows the addition of tip, note, and caution alerts in your documentation.
- Here's the live demo link: https://openlabx.com/readmex/
To get started with ReadMeX, follow these steps to run the application on your local machine.
- Python 3.x (with pip installed)
- Flask and Flask-SocketIO
- markdown2 for rendering markdown as HTML
- Bootstrap 5.x for the frontend components
- Popper.js for dropdown functionality in Bootstrap
Clone the repository and install the required dependencies using:
git clone https://github.com/openlabx/readmex.git
cd readmex
pip install -r requirements.txtTo run the application locally, execute the following command:
python run.pyIf you want to deploy ReadMeX on a public host (like PythonAnywhere), follow these steps:
python run.pyThis will start the Flask application and allow you to access the editor on http://localhost:5000.
- Ensure your public host supports Python and Flask.
- Change the WebSocket configuration to AJAX by using the app-ajax.js instead of app.js for public environments:
<script src="./static/app-ajax.js"></script>- Web: Fully functional on major browsers like Chrome, Firefox, and Edge.
- Github Readme-md.
- Local Readme-md.
- Visual studio code readme preview.
- As an external image for any webstie.
- As an Iframe.
- Use the drag-and-drop interface on the left sidebar to add markdown elements.
- Write your markdown directly into the editor pane.
- The live preview window will automatically update with the rendered HTML version of your markdown.
- Use the "Table of Contents" section to generate an outline for your README.
- For Localhost: Use 'app.js' which uses WebSockets for real-time updates:
<script src="./static/app.js"></script>- For Public Hosting: Use
app-ajax.jsto use AJAX for markdown updates:
<script src="./static/app-ajax.js"></script>- Flask: The core of the web application.
- Flask-SocketIO: For real-time communication when running on localhost.
- markdown2: To convert markdown to HTML with added features such as table support.
- HTML5 and CSS3 HTML5 and CSS3 for structure and styling.
- Bootstrap 5.x for components and responsive design.
- JavaScript and AJAX for asynchronous updates.
- Socket.IO for real-time markdown updates on localhost or public.
We welcome contributions! Here's how you can help:
- Give the project a STAR.
- Follow us on Github.
- Follow us on Social Media.
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes.
- Submit a pull request.
- Please make sure to update tests as appropriate.
- Python: The programming language used for the backend of this project.
- All Contributors: Thanks to everyone who contributed to the project.
- OpenLabX Team: Special thanks to the team for developing and maintaining the project.
- If you find a bug in this project, please do not hesistate to reach out to our team
- If you are feeling helpful, please consider fixing the bug and making a pull request
- We give our greatest thanks to any people who report or fix bugs in this project
This project is licensed under the MIT license.
We are committed to fostering an open and welcoming environment. All participants in this project are expected to adhere to our Code of Conduct, which outlines our expectations for respectful behavior and the steps for reporting unacceptable conduct.
In pursuit of innovation,
OpenLabX Team
- Website: https://openlabx.com
- Email: contact@openlabx.com
Follow Us: