Markdown Previewer with React and TypeScript

This is a project built for the FreeCodeCamp curriculum. It's a web application that allows users to write Markdown syntax in a text area, and see it dynamically compiled and rendered as formatted HTML.

Live Demo

To see this project's live demo, please click here.

Built With

This project was built with the following technologies:

• React
• TypeScript
• HTML
• CSS

Key Features

The main features of this app include:

• Live preview of Markdown syntax
• Support for all standard Markdown features
• Custom rendering of carriage returns as line breaks

Getting Started

To get a local copy up and running, follow these steps:

Prerequisites

• Node.js

Setup

1. Clone the repository
2. Navigate to the project directory in your terminal
3. Run npm install to install the necessary dependencies

Install

1. Run npm run dev to start the development server
2. Open http://localhost:3000 in your browser to view the app

Authors

👤 Lucas Erkana

• GitHub: @LucasErkana
• Twitter: @LucasErkana
• LinkedIn: Lucas Erkana

Future Improvements

In the future, I plan to add more features to this app, such as adding a full-screen mode for the editor or the previewer.

Contributing

Contributions are always welcome! If you'd like to contribute to this project, please follow these steps:

1. Fork the repository
2. Create a new branch (git checkout -b feature/your-feature-name)
3. Make your changes and commit them (git commit -am 'Add some feature')
4. Push your changes to your forked repository (git push origin feature/your-feature-name)
5. Open a pull request

Show your support

If you find this project useful or interesting, please give it a ⭐️ on GitHub!

Acknowledgments

Thanks to FreeCodeCamp for providing the curriculum that inspired this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.