Skip to content

jalalmanafi/ownmd

Repository files navigation

ownmd_screen

OwnMD.io

A modern, open-source Markdown editor for the web. Write, preview, and share your Markdown content with ease.

Features

  • 🚀 Real-time Markdown preview
  • 💾 Client-side saving
  • 🎨 Clean, minimalist interface
  • 📱 Mobile-responsive design - In progress
  • ⚡ Fast and lightweight
  • 🌐 No account required

Live Demo

Visit ownmd.io to try it out.

Getting Started

Prerequisites

  • Node.js (version 16 or higher)
  • npm or yarn

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/ownmd.io.git
cd ownmd.io
  1. Install dependencies:
npm install
# or
yarn install
  1. Start the development server:
npm run dev
# or
yarn dev
  1. Open http://localhost:5173 in your browser.

Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository
  2. Create a new branch: git checkout -b feature/your-feature-name
  3. Make your changes
  4. Commit your changes: git commit -m 'Add some feature'
  5. Push to the branch: git push origin feature/your-feature-name
  6. Submit a pull request

Tech Stack

License

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

Support

If you encounter any issues or have questions:

  • Open an issue on GitHub

Roadmap

  • Dark mode support
  • Custom themes
  • Export to PDF
  • Collaborative editing

Acknowledgments

Thanks to all contributors and users who help make OwnMD better!


Made with ❤️ and 🍻 by the jalalmanafi