Markdownify - A Minimalist Markdown Editor

Markdownify is a simple and elegant Markdown editor built using ReactJS and TypeScript. It aims to provide a distraction-free writing experience, focusing on a clean user interface with no fancy bells and whistles. With Markdownify, you can concentrate on the art of writing in Markdown, effortlessly transforming your thoughts into beautifully formatted documents.

Key Features

• Simplicity First: Markdownify takes pride in its minimalist approach, offering an uncluttered environment for your writing endeavors. No unnecessary distractions, just pure writing bliss.

• Real-Time Preview: As you type, Markdownify provides an instantaneous live preview of your Markdown content. Watch your text come to life in real-time.

• Responsive Design: Markdownify is fully responsive, ensuring a seamless writing experience across various devices, from desktops to smartphones.

• Save and Export: Effortlessly save your work locally or export it to a Markdown file on your device. Markdownify ensures that your progress is always accessible.

Getting Started with Markdownify

Welcome to Markdownify! We're delighted that you're interested in using our minimalist Markdown editor. This section will guide you through the steps to get started with Markdownify quickly.

Prerequisites

Before you begin, ensure you have the following prerequisites installed on your system:

1. Node.js and npm: Markdownify is built using ReactJS and TypeScript, which require Node.js and npm (Node Package Manager). You can download Node.js from the official website: Node.js Downloads.

Installation

Follow these steps to install Markdownify on your local machine:

1. Clone the Repository: Start by cloning the Markdownify repository to your local system using Git. Open your terminal or command prompt and run the following command:

   git clone git@github.com:suveshmoza/Markdownify.git
   

2. Navigate to the Directory: Change your working directory to the cloned repository:

   cd Markdownify
   

3. Install Dependencies: Next, install the project dependencies using npm:

   npm install
   

Running the Development Server

Once the installation is complete, you can run Markdownify in development mode. This will enable you to make changes and see them in real-time in your web browser.

Run the following command to start the development server:

npm run dev

Wait for a moment, and you should see Markdownify open in your default web browser at http://localhost:3000/.

Start Writing in Markdown!

You are all set to start using Markdownify! With its distraction-free environment and real-time preview, you can begin writing in Markdown and see the beautiful formatting come to life as you type.

Contributing Rules

We welcome contributions to Markdownify and appreciate the effort put forth by the community. To ensure a smooth collaboration process, please follow these contributing rules:

1. Fork the Repository: If you want to contribute to Markdownify, start by forking the repository to your GitHub account.

2. Branching: Create a new branch for your contributions. This keeps your changes isolated and makes it easier for us to review and merge your work.

3. Coding Standards: Maintain the coding standards and styles used in the project. Adhere to the existing code formatting to keep the codebase consistent.

4. Pull Request: When you are ready to submit your changes, create a pull request from your branch to the main branch of the original repository. Provide a clear and descriptive title for your pull request.

5. Description: In the pull request description, explain the purpose of your changes and the problem it solves. Provide any relevant context or details that can help reviewers understand your contribution better.

6. Testing: If your changes involve new features or bug fixes, include appropriate tests to ensure the code works as expected.

7. Documentation: Update the documentation, if applicable, to reflect any changes you've made. Clear and concise documentation helps other developers understand your work.

8. Be Responsive: Be responsive to feedback and comments on your pull request. If changes are requested, address them promptly and politely.

9. Code Reviews: Expect and participate in code reviews. Be open to feedback and be willing to make improvements based on reviews.

10. Report Issues: If you find any bugs or have suggestions for improvements, feel free to open an issue in the repository.

By following these contributing rules, you can help us maintain a welcoming and productive open-source community around Markdownify. Thank you for your contributions!