Skip to content

Responsive web app that allows users to write and preview markdown syntax in real-time.

License

Notifications You must be signed in to change notification settings

JuanPabloDiaz/markdownPreviewer

Markdown Previewer

This project is a responsive web application that allows users to modify and preview markdown text in real-time. The application is built with React.js, Vite.js, and Tailwind CSS.

Description πŸ’‘

This project is a Markdown Previewer, which is a simple and intuitive web application that allows users to write and preview markdown text in real-time. The application is built with React.js, Vite.js, and Tailwind CSS, and it features a sleek and modern user interface that adapts to any screen size.

This project was built as part of the freeCodeCamp Front End Libraries Certification. The goal was to build a Markdown Previewer with React.

Markdown Previewer repo

Desktop View πŸ–₯️

iPad view πŸ“±

Mobile view πŸ“±

Lighthouse Score πŸš€

Features:

  • Responsive design: Markdown Previewer adapts to any screen size, ensuring a consistent and enjoyable experience for all users.
  • Sleek and modern UI: Tailwind CSS provides a beautiful and intuitive user interface.
  • Efficient and performant: Vite.js ensures fast loading times and a smooth experience.

Built With πŸ”‘

Welcome to Markdown Previewer, a simple and intuitive pomodoro timer built with React.js, Vite.js, and Tailwind CSS.

React Vite Tailwind-CSS

Here's a closer look at the tech stack:

  • Front-End: React.js, Vite.js, Tailwind CSS
  • Back-End: N/A
  • Deployment: Vercel

Get started πŸ› οΈ

To get started with Markdown Previewer, simply clone the repository and follow the setup instructions. You'll be up and running in no time!

Setup πŸ“‹

  1. Clone the repo
  2. Install dependencies
    npm install
  3. Start the development server
    npm run dev
  4. Open http://localhost:5173/ with your browser to see the result.

Contribution 🀝

All contributions are welcome. Please read the CONTRIBUTING guidelines for details on our code of conduct, and the process for submitting pull requests.

License πŸ“œ

Markdown Previewer is licensed under the MIT License.

I hope you enjoy using the Markdown Previewer!

Other Projects πŸš€

Contact πŸ“ž

Acknowledgments πŸ“š

Resources list that I find helpful and would like to give credit to.

(πŸ‘† Top πŸ‘†)

About

Responsive web app that allows users to write and preview markdown syntax in real-time.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Contributors