Skip to content

mikeldev0/markdownAnything

Repository files navigation

MarkdownAnything Logo

🎯 Easily convert any file to Markdown format

Project Status Version License

MarkdownAnything Preview

✨ Features

  • 📝 Instant Markdown conversion
  • 🎨 Modern and responsive interface
  • 🌓 Support for dark/light mode
  • 📋 One-click clipboard copying
  • 🚀 Automatic installation and configuration
  • 💻 Cross-platform (Windows, macOS, Linux)

🛠️ Prerequisites

  • Node.js >= 14
  • Python >= 3.8
  • pip (Python package manager)

⚡ Quick Installation

  1. Clone the repository:
git clone https://github.com/byronnDev/markdownanything.git
cd markdownanything
  1. Install dependencies and set up the environment:
npm run setup

This command:

  • Creates a Python virtual environment
  • Installs Python dependencies
  • Installs Node.js dependencies
  • Sets up necessary directories

🚦 Usage

  1. Start the application:
npm start
  1. Open your browser at http://localhost:3002
  2. Upload any supported file
  3. Get your markdown!
  4. Once uploaded, make sure to update these URLs in README.md:

📋 Supported Formats

  • Text documents (.txt, .doc, .docx)
  • Spreadsheets (.xlsx, .csv)
  • Presentations (.ppt, .pptx)
  • PDF (.pdf)
  • And more...

🔧 Technologies

  • Frontend:
    • HTML5
    • CSS3
    • JavaScript (ES6+)
  • Backend:
    • Node.js
    • Express
    • Python
    • markitdown (Python library)

🤝 Contributing

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add: some amazing feature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

✨ Credits

Developed with ❤️ by Mikel Echeverria

About

Easily convert any file to Markdown format. Show demo (works in local only)

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published