Implement Enhanced Features for Markdown Editor #508
Assignees
Labels
Comments
|
Thank you for raising this issue! We'll look into it as soon as possible. Please ensure that the issue is not duplicate, and you read CONTRIBUTING.md carefully. Your contributions are highly appreciated! 😊 |
dhairyagothi
added a commit
that referenced
this issue
Jan 14, 2025
## Related Issue Issue No. #508 ## Description Added New Features to the Text 2 Readme Project In this update, I have implemented several key features to enhance the user experience in the editor and improve the overall functionality: 1. Editor with Markdown Support: Integrated a markdown editor where users can write and edit markdown text. The editor automatically updates the live preview in real-time, using the ReactMarkdown component to render the markdown content in a visually formatted way. 2. Navbar with Text Selection: Developed a reusable Navbar component with the ability to insert predefined text into the markdown editor. This feature simplifies the process for users by allowing them to easily add common text elements (like headers, lists, etc.) with just a click. 3. Download Feature: Added a "Download" button at the bottom of the editor. The button allows users to download the markdown content generated in the editor as a .md file. This feature provides users with an easy way to export their generated README content. 4. Responsive Behavior: Included a check to detect screen size, displaying an alert when the user is not on a PC, advising them to switch to a larger screen for an optimal experience. ## Type of PR - [ ] Bug fix - [x] Feature enhancement - [ ] Documentation update - [ ] Security enhancement - [ ] Other (specify): _______________ check in issue by entering [X] in boxes ## Screenshots / Videos (if applicable)    [Attach any relevant screenshots or videos demonstrating the changes] ## Checklist - [x] I have performed a self-review of my code. - [x] I have read and followed the Contribution Guidelines. - [x] I have tested the changes thoroughly before submitting this pull request. - [x] I have provided relevant issue numbers, screenshots, and videos after making the changes. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have followed the code style guidelines of this project. - [x] I have checked for any existing open issues that my pull request may address. - [x] I have ensured that my changes do not break any existing functionality. - [x] Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently. - [x] I have read the resources for guidance listed below. - [x] I have followed security best practices in my code changes. check in issue by entering [X] in boxes ## Contribution Guidelines Thank you for considering contributing to our project! To ensure smooth collaboration and effective contribution management, please adhere to the following guidelines: ### Issue Creation 1. **Limit on Issues:** - Each contributor is allowed to create a maximum of **4 issues per day**. This helps us manage and address issues efficiently. ### Contribution Levels 2. **Basic Contributions:** - This project is primarily focused on documentation. Most of the setup has been completed, so contributors will generally need to work on basic code tasks, such as writing tests. - For these tasks, issues will be assigned the **Easy** label. 3. **Acknowledging Hard Work:** - If a contributor puts in significant effort on a task, the issue will be upgraded to **Medium**. This is our way of recognizing and appreciating extra effort. 4. **Feature Additions and Component Work:** - Contributors working on new features or components using JSX/TSX will be assigned a level based on the complexity and quality of their work. - The more complex and valuable the contribution, the higher the level assigned. ### Level Definitions - **Easy:** - Tasks are straightforward, such as fixing minor bugs, writing tests, or making simple documentation updates. - **Medium:** - Tasks require more effort, such as addressing complex bugs, improving existing features, or making substantial documentation improvements. - **Hard:** - Tasks are highly complex and involve significant new feature development, major refactoring, or extensive contributions to the project’s core components. We look forward to your contributions and appreciate your effort in helping us improve the project!
|
Hello @R0hanNayan! Your issue #508 has been closed. Thank you for your contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description:
The current markdown editor lacks several functionalities that are crucial for improving user experience. This issue tracks the development of features like markdown support, a text selection navbar, a file download option, and responsive behavior alerts for non-PC users.
Proposed Features:
Add real-time markdown preview to allow users to see formatted content as they type.
Create a navbar with predefined text options (e.g., headers, lists) for easier markdown editing.
Include a "Download" button that lets users export their editor content as a .md file.
Detect screen size and show an alert if the application is accessed on a non-PC device, encouraging users to switch to a larger screen.
The text was updated successfully, but these errors were encountered: