This is a Markdown Previewer web application built with React. It allows you to enter Markdown text and see the rendered HTML output in real-time.
- Textarea for entering Markdown text.
- Preview area that displays the rendered HTML output.
- Supports GitHub flavored Markdown.
- Default text with examples of various Markdown elements.
- Real-time updating of the preview as you type.
- Interprets carriage returns as line breaks (bonus feature).
- React: JavaScript library for building user interfaces.
- marked: A Markdown parsing library for converting Markdown to HTML.
- HTML: Markup language for creating the structure of the web page.
- CSS: Styling language for designing the appearance of the web page.
- Bootstrap: CSS framework for responsive and mobile-first web development.
To run the Markdown Previewer locally, follow these steps:
- Clone the repository:
git clone https://github.com/Vkube/A_Markdown_Previewer.git
- Navigate to the project directory:
cd markdown-previewer
- Install the dependencies:
npm install
- Start the development server:
npm start
- Start the development server:
npm start
Open your web browser and visit http://localhost:3000 to see the Markdown Previewer app.
- In the editor textarea, enter your Markdown text. You can type or paste Markdown content.
- The preview area will update in real-time to display the rendered HTML output.
- As you continue typing or making changes to the Markdown text, the preview will update accordingly.
- You can modify the default Markdown text provided in the editor to see different examples of Markdown elements.
- React
- marked
- Bootstrap
This project is licensed under the MIT License. See the LICENSE file for details.