enzo-mourany / typescript-markdown-visualizer

React typescript app to see how your changes will look before you commit them. With this tool, you can quickly and easily create and edit Markdown documents without having to worry about the formatting

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact
7. Acknowledgments

About The Project

This markdown visualizer is a simple project that I made to learn more about TypeScript and React. It is a simple markdown visualizer that allows you to write markdown and see the result in real time. It is also possible to save the markdown in a file and load it later.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

  or

• pnpm

  npm install -g pnpm

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/enzo-mourany/typescript-markdown-visualizer

2. Install NPM packages

   npm install

3. Run the project

    npm run dev

4. Open the project in your browser

(back to top)

Usage

This project is a simple markdown visualizer. You can write markdown and see the result in real time. It is also possible to save the markdown in a file and load it later.

(back to top)

Roadmap

• Add markdown visualizer
• Download markdown file as .md
• Download markdown file as PDF

See the open issues for a list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Enzo Mourany - @vincenzomry - Linkedin - [e-mail]

(back to top)

Acknowledgements

• Vite
• react-markdown

(back to top)

Support

Give a ⭐️ if this project helped you!