https://github.com/ismail9700/markitdown-app
MarkItDown is a lightweight markdown editor web application that enables users to write, preview, and format markdown content in real-time. Users can save documents locally or store them in the browser. Built with a mobile-first approach, it offers a clean and responsive interface.
https://github.com/ismail9700/markitdown-app
markdown note-taking webapp
Last synced: 9 months ago
JSON representation
MarkItDown is a lightweight markdown editor web application that enables users to write, preview, and format markdown content in real-time. Users can save documents locally or store them in the browser. Built with a mobile-first approach, it offers a clean and responsive interface.
- Host: GitHub
- URL: https://github.com/ismail9700/markitdown-app
- Owner: ismail9700
- Created: 2025-09-11T14:11:00.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-09-11T17:24:07.000Z (10 months ago)
- Last Synced: 2025-09-11T19:43:16.180Z (10 months ago)
- Topics: markdown, note-taking, webapp
- Language: JavaScript
- Homepage: https://i-markitdown.netlify.app/
- Size: 639 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MarkItDown
## About
MarkItDown is a lightweight markdown editor web application that enables users to write, preview, and format markdown content in real-time. Users can save documents locally or store them in the browser. Built with a mobile-first approach, it offers a clean and responsive interface.
Check out the [React version](https://github.com/Ismail970/MarkItDown-react) of this app.
## Demo
[**Try MarkItDown Live**](https://i-markitdown.netlify.app/)
## Screenshots
## Built With
- **Semantic HTML5 Markup**: Structured content for accessibility and SEO.
- **SCSS/SASS**: Advanced CSS styling with variables and nesting.
- **Mobile-First Workflow**: Responsive design optimized for mobile devices.
- **JavaScript ES6+**: Modern JavaScript for dynamic functionality.
- **[Markdown-it](https://www.npmjs.com/package/markdown-it)**: Markdown parsing and rendering.
- **[File-saver](https://www.npmjs.com/package/file-saver)**: Enables saving files locally.
- **[FontAwesome](https://fontawesome.com/)**: Icons for enhanced UI.
- **[Parcel](https://parceljs.org/)**: Zero-config bundler for efficient development.
## Features
- **Real-Time Preview**: Instantly view rendered markdown as you type.
- **Save Options**: Save markdown files locally or store them in browser local storage.
- **Responsive Design**: Works seamlessly across desktop, tablet, and mobile.
- **Markdown Support**: Supports standard markdown syntax for text formatting.
- **Modern UI**: Clean and intuitive interface with icon support.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/ismail9700/markitdown-app.git
```
2. Navigate to the project directory:
```bash
cd markitdown-app
```
3. Install dependencies:
```bash
npm install
```
4. Start the development server with Parcel:
```bash
npm run start
```
Alternatively, open `index.html` in a browser for static viewing.
## Usage
- Open the app in a browser to start writing markdown.
- Use the editor to type and preview markdown content in real-time.
- Save documents locally or in the browser using the provided options.
- Customize the HTML, SCSS, or JavaScript to adjust functionality or styling.
## Contributing
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes and commit (`git commit -m "Add feature"`).
4. Push to the branch (`git push origin feature-branch`).
5. Open a pull request.
## License
MIT License. See [LICENSE](LICENSE) for details.
## Contact
For questions or feedback, reach out to [ismail9700](https://github.com/ismail9700).