MarkView

MarkView is a simple and user-friendly Markdown Previewer built to help users write and preview Markdown in real-time. This project is part of Android Club Winter of Code 2024 and is open for contributions!

---

Current Features

• Live Markdown Editing: Type your Markdown and preview the formatted content by clicking the "Show Preview" button.
• Customizable Themes: Switch between different themes to style your preview.
• Download as HTML: Save your Markdown preview as an HTML file.
• Beginner-Friendly Codebase: Aimed at fostering contributions from beginner-level developers.

---

Technologies Used

• HTML5
• CSS3
• JavaScript
• Marked JS Library (check here)
• GitHub Pages for Deployment

---

Demo

Visit the live version of the project here.

---

Project Structure

MarkView
├── src
│   ├── styles 
│   │   ├── about.css
│   │   ├── base.css
│   │   ├── components.css
│   │   ├── file_upload.css
│   │   ├── footer.css
│   │   └── themes.css
│   ├── about.html
│   ├── file_upload.html
│   ├── footer.html
│   ├── index.html
│   ├── navbar.html
│   ├── script.js
│   └── Readme.md
├── .github
│   ├── ISSUE_TEMPLATE 
│   └── workflows
│       └── pages.yml
├── LICENSE 
└── README.md

---

-Base.css has styles for index.html -components has navbar and common components for index and others -script.js has all the javascripts

Getting Started

Prerequisites

• Basic understanding of HTML, CSS, and JavaScript.
• A GitHub account for cloning and contributing to the repository.

Installation Steps

1. Clone the repository:

   git clone https://github.com/Jyotibrat/MarkView.git

2. Navigate to the project directory:

   cd MarkView

3. Open the project in a browser:
   • Use any local server or open index.html directly in a browser.

---

How to Contribute

We welcome contributions of all kinds! Here are some areas you can work on:

Contributors can be made

• Enhance Markdown Parsing: Improve the parsing logic to support more Markdown syntax.
• Add Themes: Create new themes for the previewer.
• Improve UI/UX: Make the interface more visually appealing and user-friendly.
• Bug Fixes: Identify and fix any bugs in the project.

Steps to Contribute

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature-name

3. Commit your changes:

   git commit -m "Add a descriptive commit message"

4. Push your changes:

   git push origin feature-name

5. Create a pull request.

---

Contact

For any queries or suggestions, feel free to reach out:

• GitHub: Jyotibrat
• Email: [email protected]

---

License

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

---

Join us and make this project even better! Happy Coding and Stay Motivated!

---