Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Editor and Markdown Feature #496

Closed
wants to merge 1 commit into from

Conversation

R0hanNayan
Copy link
Contributor

Related Issue

Issue No. #416

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.

  1. 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.

  1. 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.

  1. 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
  • Feature enhancement
  • Documentation update
  • Security enhancement
  • Other (specify): _______________

check in issue by entering [X] in boxes

Screenshots / Videos (if applicable)

1
2
3

[Attach any relevant screenshots or videos demonstrating the changes]

Checklist

  • I have performed a self-review of my code.
  • I have read and followed the Contribution Guidelines.
  • I have tested the changes thoroughly before submitting this pull request.
  • I have provided relevant issue numbers, screenshots, and videos after making the changes.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have followed the code style guidelines of this project.
  • I have checked for any existing open issues that my pull request may address.
  • I have ensured that my changes do not break any existing functionality.
  • Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently.
  • I have read the resources for guidance listed below.
  • 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

  1. 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.
  2. 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.
  3. 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!

Copy link

vercel bot commented Jan 11, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
100-days-100-web-project ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 11, 2025 4:15pm

Copy link
Contributor

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our CONTRIBUTING.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

@dhairyagothi
Copy link
Owner

don't create multiple PR for a single issue already a PR is merged with same issuee

@R0hanNayan
Copy link
Contributor Author

don't create multiple PR for a single issue already a PR is merged with same issuee

Okay I'll create a new issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants