https://github.com/pooulad/html2markdown
🪄Easily convert html to markdown
https://github.com/pooulad/html2markdown
convertor markdown markup mdx nextjs nextjs14 nextui react-hot-toast reactjs tailwindcss vercel
Last synced: 2 months ago
JSON representation
🪄Easily convert html to markdown
- Host: GitHub
- URL: https://github.com/pooulad/html2markdown
- Owner: pooulad
- License: mit
- Created: 2024-12-10T15:58:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-12T00:16:30.000Z (over 1 year ago)
- Last Synced: 2025-02-05T19:02:35.976Z (over 1 year ago)
- Topics: convertor, markdown, markup, mdx, nextjs, nextjs14, nextui, react-hot-toast, reactjs, tailwindcss, vercel
- Language: TypeScript
- Homepage: https://html2markdown-online.vercel.app/
- Size: 2.15 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HTML to Markdown Converter
A simple, fast web-based tool to convert HTML content into Markdown format. The converter is built with **Next.js**, **React**, and **TailwindCSS**, ensuring modern design and smooth user experience.
## ✨ Features
- **Real-time Conversion**: Automatically converts HTML input into Markdown as you type.
- **Clear and Copy Options**:
- Clear both input and output fields with a single click.
- Copy Markdown output to the clipboard effortlessly.
- **Dark and Light Mode**: Seamlessly adapts to your system's theme preference.
- **Modern UI**: Powered by TailwindCSS for a sleek and accessible interface.
## 🚀 Live Demo
Check out the live demo of the converter: **[Live Demo](https://html2markdown-online.vercel.app/)**
## 🛠 Installation
Follow these steps to get the project running locally:
1. **Clone the repository**:
```bash
git clone https://github.com/pooulad/html2markdown.git
cd html2markdown
```
2. **Install dependencies:**:
```bash
yarn install
```
3. **Run the development server:**:
```bash
yarn dev
```
4. **Open http://localhost:3000 in your browser.**:
## 📄 Usage
1. Enter or paste your HTML code in the **HTML Input** text area.
2. View the converted Markdown in the **Markdown Output** text area.
3. Use the **Copy** button to copy the Markdown to your clipboard.
4. Use the **Clear All** button to reset the input and output fields.
## 🌄 Screenshot
## 🛡️ Technologies Used
- **Next.js**: For building the React-based application.
- **React**: For the user interface.
- **TailwindCSS**: For modern styling.
- **Turndown.js**: For converting HTML to Markdown.
- **@nextui-org**: For add fast and modern React UI Library.
- **@next-mdx**: For render mdx file in nextjs project.
## 👨💻 Contributing
Contributions are welcome! To contribute:
1. Fork the repository.
2. Create a feature branch:
bash
Copy code
`git checkout -b feature-name`
3. Commit your changes:
bash
Copy code
`git commit -m "Add feature-name"`
4. Push to your branch:
bash
Copy code
`git push origin feature-name`
5. Open a pull request.
## 🛡️ License
This project is licensed under the MIT License.
## 💬 FAQ
### What is Markdown?
Markdown is a lightweight markup language that allows you to format plain text into structured documents, like headings, lists, and more.
### Why use Markdown?
Markdown is platform-independent, easy to read and write, and can be converted to other formats like HTML or PDF.
### Can I use this tool on mobile devices?
Yes! The application is fully responsive and works seamlessly on mobile, tablet, and desktop devices.
## 🌟 Acknowledgements
- [Turndown.js](https://github.com/domchristie/turndown): The core library for converting HTML to Markdown.
- [Next.js](https://nextjs.org/): The powerful React framework.
- [TailwindCSS](https://tailwindcss.com/): For building the stunning UI.