Dazy

MarkText: A Next-Generation Markdown Editor 📝

Table of Contents

• What is MarkText?
• Key Features
• Installation
• Usage
• Editing Modes
• Markdown Standards Support
• Contributing
• License
• Contact

What is MarkText?

MarkText is a free, open-source, WYSIWYG Markdown editor built with Electron. It works seamlessly on macOS, Windows, and Linux. MarkText aims to provide a clean and efficient writing experience for users who prefer Markdown for their documents.

You can find the latest releases here.

Key Features

Real-Time Preview & Clean UI

MarkText offers an instant live preview of your Markdown content. You won’t need a split-pane view; instead, enjoy a seamless writing experience. The clean user interface allows you to focus solely on your content.

Markdown Standards Support

MarkText fully supports CommonMark and GitHub-Flavored Markdown. It also includes selective features from Pandoc. This ensures that your Markdown documents are compatible with a wide range of tools and platforms.

Extensions

MarkText includes useful extensions such as:

• Inline and Block Math: Use KaTeX for mathematical expressions.
• Front-Matter: Add metadata to your Markdown files.
• Emoji Support: Enhance your documents with emojis.

Installation

To install MarkText, visit the Releases section on GitHub. Download the appropriate version for your operating system and follow the installation instructions.

For macOS

1. Download the .dmg file from the releases page.
2. Open the file and drag MarkText to your Applications folder.

For Windows

1. Download the .exe file from the releases page.
2. Run the installer and follow the prompts.

For Linux

1. Download the appropriate package for your distribution.
2. Use your package manager to install it.

Usage

Once installed, open MarkText to start writing. You can create new documents or open existing Markdown files. The editor provides a clean interface, allowing you to focus on your writing.

Features Overview

• Real-Time Preview: See changes as you type.
• Markdown Formatting: Easily format text using Markdown syntax.
• Extensions: Access additional features through the settings.

Editing Modes

MarkText offers multiple editing modes to suit your writing style:

Source Code Mode

View and edit the raw Markdown. This mode is perfect for those who prefer working directly with the code.

Typewriter Mode

In this mode, the cursor stays centered as you type. This helps maintain focus on your writing without distractions.

Focus Mode

Focus Mode highlights only the current line you are working on. This feature minimizes distractions and enhances concentration.

Markdown Standards Support

MarkText adheres to widely accepted Markdown standards, ensuring compatibility across different platforms. It supports:

• CommonMark: A widely used Markdown specification.
• GitHub-Flavored Markdown: Additional features for GitHub users.
• Selective Pandoc Features: Access to advanced formatting options.

Contributing

We welcome contributions to MarkText. If you want to help improve the project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Submit a pull request with a description of your changes.

For detailed guidelines, please check the CONTRIBUTING.md file in the repository.

License

MarkText is licensed under the MIT License. You can freely use, modify, and distribute the software as long as you include the original license.

Contact

For questions or support, please open an issue in the GitHub repository or reach out to the community. You can also follow the project on social media for updates and announcements.

Visit the Releases section for the latest updates and download options.