Giter VIP home page Giter VIP logo

milliorn / markdown-previewer Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 0.0 1.86 MB

Markdown Previewer allows users to write and preview markdown syntax in real-time. It provides a convenient way to create formatted content, such as documentation, blog posts, and README files, using simple and intuitive markup.

Home Page: https://milliorn.github.io/markdown-previewer/

HTML 24.84% JavaScript 74.14% CSS 1.02%
marked document-formatter freecodecamp freecodecamp-challenge freecodecamp-frontend freecodecamp-project front-end-development live-preview markdown-editor markdown-preview

markdown-previewer's Introduction

Markdown Previewer

CodeQL

This repository contains the code for a Markdown Previewer web application. The Markdown Previewer allows users to write and preview markdown syntax in real-time. It provides a convenient way to create formatted content, such as documentation, blog posts, and README files, using simple and intuitive markup.

The project is built using React and utilizes the marked library for rendering the markdown. It follows the specifications of the freeCodeCamp challenge: Build a Markdown Previewer.

Features

  • Real-time preview of markdown syntax
  • Editable markdown input area
  • Rendering of markdown into HTML
  • Support for common markdown elements such as headings, lists, links, and more

Live Demo

To see the Markdown Previewer in action, visit the live demo.

Technologies Used

  • React: JavaScript library for building user interfaces
  • marked: A markdown parser and compiler for JavaScript
  • HTML: Markup language for structuring the web page
  • CSS: Styling language for designing the user interface

Getting Started

To run the Markdown Previewer locally, follow these steps:

  1. Clone the repository: git clone https://github.com/milliorn/markdown-previewer.git
  2. Navigate to the project directory: cd markdown-previewer
  3. Install the dependencies: npm install
  4. Start the development server: npm start
  5. Open http://localhost:3000 in your browser to view the Markdown Previewer.

Contributing

Contributions are welcome! If you have any suggestions, improvements, or bug fixes, please create an issue or submit a pull request.

Deployment

The project is deployed using GitHub Pages. The live demo can be accessed at http://milliorn.github.io/markdown-previewer.

License

This project is licensed under the MIT License.

Acknowledgements

The Markdown Previewer project is part of the freeCodeCamp curriculum. Special thanks to freeCodeCamp for providing the project specifications and resources.

markdown-previewer's People

Contributors

dependabot[bot] avatar github-actions[bot] avatar milliorn avatar renovate[bot] avatar

Stargazers

 avatar

Watchers

 avatar  avatar

markdown-previewer's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

github-actions
.github/workflows/combine-prs.yml
  • actions/github-script v6
.github/workflows/dependency-review.yml
  • actions/checkout v3
  • actions/dependency-review-action v3
npm
package.json
  • marked ^6.0.0
  • react ^18.2.0
  • react-dom ^18.2.0
  • react-helmet ^6.1.0
  • react-scripts 5.0.1
  • gh-pages ^5.0.0
  • tailwindcss ^3.3.2

  • Check this box to trigger a request for Renovate to run again on this repository

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.