Git Product home page Git Product logo

hirentimbadiya / markdown-previewer Goto Github PK

View Code? Open in Web Editor NEW
7.0 7.0 19.0 51 KB

Participate in Hacktoberfest by contributing to any Open Source project on GitHub! Here is a starter project for first time contributors. This project can involve HTML, CSS, and JavaScript.

Home Page: https://previewer-for-markdown.vercel.app

License: MIT License

HTML 19.23% CSS 63.95% JavaScript 16.83%
contributions-welcome hacktoberfest hacktoberfest-accepted hacktoberfest2023 markdown markdown-previewer opensourceforgood

markdown-previewer's Introduction

Hiren Timbadiya

hirentimbadiya

heyhiru

Connect with me:

heyhiru hirentimbadiya74 hiren-timbadiya hirentimbadiya74

Languages and Tools:

markdown-previewer's People

Contributors

aaron-jacob avatar anshu-ee-21 avatar bhavymunjani avatar brijeshbhikadiya avatar cstrp avatar himughanakash avatar hirentimbadiya avatar mrical avatar prince5638 avatar rishikeshk07 avatar vanshsutariya avatar vivekbaldha0712 avatar yr1404 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

markdown-previewer's Issues

Textarea Overlow

Describe the bug
The textarea field of the Input field overflow from its div.

To Reproduce
Steps to reproduce the behavior:

  1. Go to homepage
  2. See error

Screenshots
If applicable, add screenshots to help explain your problem.

image

Desktop (please complete the following information):

  • OS: Linux
  • Browser: Edge
  • Version: 117

Additional context
I have fixed it and working on a PR.

rewrite the 12th point title in contributing.md

rewrite the 12th point title in contributing.md file to :
When other developers update the master branch while you're working on your own branch, your branch becomes outdated and lacks the latest content. To get these changes, follow these steps.

Markdown input area is not Responsive

Describe the bug
The Markdown input area is not responsive preview input area is alright.
on decreasing the size of screen it is going out of section.
image

I will fix it please assign me this task.

Add CSS to HTML page

About Issue :
add the styling to the page and make all sections center. and row value for text-area is bit higher so decrease it accordingly. i.e. 25 or 20.

ScreenShot
image

Fix: Previewer content overflow

Describe the bug
The content inside the markdown previewer overflows

To Reproduce
Steps to reproduce the behavior:

  1. Go to 'WEBSITE'
  2. Add content/markdown of good enough size/length on 'Markdown input area'
  3. This generated a preview of markdown in the Markdown Preview section
  4. See error The Generated preview overflows the preview section

Expected behavior
The Generated preview must come under the boundaries of the preview section
chrome_31Km6gY83P

Screenshots
Content overflows preview section
chrome_nhA81HS0C1

Desktop (please complete the following information):

  • OS: [Windows]
  • Browser [Chrome]
  • Version [22]

Smartphone (please complete the following information):

  • Device: []
  • OS: []
  • Browser []
  • Version []

Additional context

Code block preview not available

Describe the bug
Code is not properly displayed in the preview section.

To Reproduce
Steps to reproduce the behavior:

  1. Add code contents using backticks ` `
  2. You can see that code is not properly displayed

Expected behavior
A code block should be displayed containg the content inside backticks ` `

Screenshots
image

Desktop (please complete the following information):

  • OS: Ubuntu
  • Browser Chrome
  • Version 117

Bug: markdown preview content coming out of card

Describe the bug
markdown preview content coming out of the card

To Reproduce
Steps to reproduce the behavior:

  1. Fill as much markdown code as possible
  2. Check the preview card

Expected behavior
content not out from card markdown preview

Screenshots
image

Desktop (please complete the following information):

  • OS: MacOS
  • Browser Brave

Update Header UI and Enhance UI/UX in Markdown Previewer Layout

This issue aims to enhance the user interface of the Markdown Previewer repository by updating the Header's UI and making various UI/UX improvements. These changes will help make the Markdown Previewer more visually appealing and user-friendly.

Navbar UI Update:

  • Design and implement a more modern and visually pleasing header.
  • Ensure that the updated header is responsive and looks good on various screen sizes and devices.

Dark & Light Mode Button:

  • Update the Dark & Light Mode button to include spacing on the left and right.

Layout Update:

  • Ensure spacing between elements is uniform and visually appealing.
  • Review the width of different sections or elements and adjust them to create a balanced, user-friendly layout.

make section items in center

we have implemented out divs in section i want them to be in center.

so use justify-content: center and align-items: stretch to make it center.

Current Behaviour :
image

Desired Behaviour :
image

Responsiveness issue

Problem:
The current implementation of the cards lacks responsiveness, resulting in inconsistent card display across various devices with different screen widths.

Expected Behavior:
The cards should adapt to the available screen width on various devices, including desktops, tablets, and mobile phones.

Current Behavior:
The cards do not respond to changes in screen width, causing them to appear overlapped on smaller screens.

Steps to Reproduce:

  • Open the application on a desktop with a large screen and observe the layout of the cards.
  • Resize the browser window to simulate a smaller screen width (e.g., tablet or mobile device).

Screenshot 2023-10-07 153957
Screenshot 2023-10-07 154309

Suggestion: Add Custom Template for PRs

Problem

Currently, when contributors open pull requests (PRs) in this repository, there is no standardized format or template to follow for their PR descriptions. This can lead to inconsistent information, missing details, and increased friction in the code review process.

Solution

I propose that we implement a custom template for PRs in this repository. By providing a standardized template, we can achieve several benefits:

Consistency: A custom PR template ensures that every PR includes essential information such as the purpose of the change, related issues, and a checklist for reviewers.
Clarity: It helps contributors clearly communicate the purpose and impact of their changes, making it easier for reviewers to understand the context.
Efficiency: A template can prompt contributors to include necessary details upfront, reducing back-and-forth communication during code reviews.
Quality: It encourages contributors to think about tests, documentation, and adherence to coding guidelines.

Example

Description

This PR Fixes #[issue-number]

Changes Made

[Describe the changes made in your PR]

Screenshots

[If applicable]

Checklist

  • I have tested the changes.
  • I have updated documentation if necessary.
  • I have assigned this PR to myself.
  • I have added the appropriate labels.

Related Issues

[Link to related issues or discussions]

Impact

Implementing a custom PR template would streamline our contribution process and enhance the overall quality of PR submissions. It would benefit both the contributors and the reviewers, making collaboration more efficient.

move script tag after the body ends and also add defer keyword.

  • It's generally a good practice to place your <script> tags just before the closing </body> tag to ensure that your HTML content is loaded before your scripts are executed.

  • Add a defer attribute to the <script> tag like this.

<script src="script.js" defer></script>

change readme file introduction

change readme file introduction to this :
A simple web application that permits users to input Markdown and instantly view a preview of the formatted text. This project encompasses HTML, CSS, and JavaScript. Novices can focus on designing the input and output layout, while slightly more experienced beginners can implement real-time updating functionalities.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.