marktext
📝A simple and elegant markdown editor, available for Linux, macOS and Windows.
Top Related Projects
Universal markup converter
The Markdown-based note-taking app that doesn't suck.
A personal knowledge management and sharing system for VSCode
A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: http://trello.com/b/8txSM12G/roadmap
Quick Overview
MarkText is an open-source, cross-platform Markdown editor that aims to provide a seamless experience for creating and editing Markdown documents. It offers a clean, distraction-free interface with real-time preview and various features to enhance productivity and writing experience.
Pros
- Cross-platform compatibility (Windows, macOS, Linux)
- Real-time preview with WYSIWYG editing
- Support for various Markdown flavors and extensions
- Customizable themes and export options
Cons
- Relatively new project, may have some stability issues
- Limited integration with external services compared to some competitors
- Some advanced features may require a learning curve for new users
Getting Started
To get started with MarkText:
- Visit the MarkText releases page on GitHub.
- Download the appropriate version for your operating system.
- Install the application following the standard procedure for your OS.
- Launch MarkText and start creating or editing Markdown documents.
For developers who want to contribute or run from source:
git clone https://github.com/marktext/marktext.git
cd marktext
yarn
yarn run dev
This will clone the repository, install dependencies, and run the development version of MarkText.
Competitor Comparisons
Universal markup converter
Pros of Pandoc
- More versatile, supporting a wider range of input and output formats
- Command-line interface allows for easy integration into scripts and workflows
- Extensive documentation and large community support
Cons of Pandoc
- Steeper learning curve, especially for non-technical users
- Lacks a graphical user interface for easier document editing and preview
Code Comparison
Pandoc (Haskell):
readMarkdown :: ReaderOptions -> Text -> Pandoc
readMarkdown opts s = readWithM parseMarkdown opts s
writeMarkdown :: WriterOptions -> Pandoc -> Text
writeMarkdown opts doc = render $ writeMarkdown' opts doc
MarkText (JavaScript):
export const convertMarkdownToHtml = markdown => {
return marked(markdown, {
gfm: true,
breaks: true,
sanitize: false,
smartLists: true,
smartypants: true
})
}
Pandoc uses Haskell for its core functionality, while MarkText is built with JavaScript and Electron. Pandoc's code focuses on flexible parsing and writing of various formats, whereas MarkText emphasizes Markdown-specific rendering and editing features.
The Markdown-based note-taking app that doesn't suck.
Pros of Notable
- Built with Electron and React, offering a modern and responsive user interface
- Supports nested notebooks and tags for better organization of notes
- Includes a WYSIWYG editor with real-time preview
Cons of Notable
- Lacks some advanced Markdown features found in MarkText
- Has a steeper learning curve for users new to note-taking applications
- Less frequent updates and smaller community compared to MarkText
Code Comparison
MarkText (Vue.js component):
<template>
<div class="editor-container">
<editor :value="content" @input="updateContent" />
</div>
</template>
<script>
export default {
// Component logic
}
</script>
Notable (React component):
import React from 'react';
import Editor from './Editor';
const NoteEditor = ({ content, onChange }) => (
<div className="note-editor">
<Editor value={content} onChange={onChange} />
</div>
);
export default NoteEditor;
Both projects use component-based architectures, but MarkText utilizes Vue.js while Notable employs React. The code structures reflect their respective framework choices, with MarkText using a single-file component approach and Notable using a more modular React component structure.
A personal knowledge management and sharing system for VSCode
Pros of Foam
- Integrates seamlessly with Visual Studio Code, leveraging its extensive ecosystem
- Focuses on networked thought and knowledge management with features like backlinks and graph visualization
- Highly extensible and customizable through VS Code extensions
Cons of Foam
- Steeper learning curve due to its integration with VS Code and reliance on extensions
- Less user-friendly for those seeking a standalone, dedicated markdown editor
- May require more setup and configuration to achieve desired functionality
Code Comparison
Foam (using VS Code API):
import * as vscode from 'vscode';
export function activate(context: vscode.ExtensionContext) {
console.log('Foam is now active!');
}
MarkText (using Electron):
const { app, BrowserWindow } = require('electron')
function createWindow () {
const win = new BrowserWindow({ width: 800, height: 600 })
win.loadFile('index.html')
}
Summary
Foam is a powerful knowledge management system built on top of VS Code, offering advanced features for networked thought and extensibility. MarkText, on the other hand, is a standalone markdown editor with a focus on user-friendly interface and WYSIWYG editing. While Foam excels in customization and integration with development workflows, MarkText provides a more straightforward experience for users primarily interested in markdown editing without additional complexity.
A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: http://trello.com/b/8txSM12G/roadmap
Pros of Logseq
- Built-in graph view for visualizing connections between notes
- Supports bidirectional linking and block references
- Offers both local storage and cloud sync options
Cons of Logseq
- Steeper learning curve due to its unique structure and features
- Less focus on traditional document editing and formatting
Code Comparison
Logseq (ClojureScript):
(defn get-block-by-uuid [uuid]
(when uuid
(db/entity [:block/uuid (uuid/uuid uuid)])))
MarkText (JavaScript):
export const getMarkdownModeFromState = state => {
return state.typewriter.markdownMode
}
Key Differences
MarkText is primarily a Markdown editor with a focus on document creation and formatting, while Logseq is a knowledge management tool with features for organizing and connecting information. MarkText offers a more traditional writing experience, whereas Logseq emphasizes non-linear note-taking and knowledge linking.
MarkText may be more suitable for users who need a straightforward Markdown editor, while Logseq caters to those who prefer a networked thought approach to note-taking and knowledge management.
Both projects are open-source and actively maintained, but they serve different primary purposes within the realm of text editing and note-taking applications.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
MarkText
A simple and elegant open-source markdown editor that focused on speed and usability.
Available for Linux, macOS and Windows.
Website | Features | Downloads | Development | Contribution
Supporting MarkText
MarkText is an MIT licensed open source project, and the latest version will always be downloadable for free from the GitHub release page. MarkText is still in development, and its development is inseparable from all sponsors. I hope you join them:
- Become a backer or sponsor on Patreon or One time donation
- Become a backer or sponsor on Open Collective
What's the difference between Patreon and Open Collective?
Patreon: Funds will be directly sponsored to Luo Ran (@jocs) who created MarkText and continues to maintain it. Open Collective: All expenses are transparent. The funds will be used for the development and maintenance of MarkText, funding online and offline activities, and acquiring other necessary resources. Names and company logos of all sponsors (from both Patreon and Open Collective) will appear on the official website for MarkText and in its README.md file.
Special Sponsors
Platinum Sponsors
Gold Sponsors
Silver Sponsors
Bronze Sponsors
Backers
Screenshot
Features
- Realtime preview (WYSIWYG) and a clean and simple interface to get a distraction-free writing experience.
- Support CommonMark Spec, GitHub Flavored Markdown Spec and selective support Pandoc markdown.
- Markdown extensions such as math expressions (KaTeX), front matter and emojis.
- Support paragraphs and inline style shortcuts to improve your writing efficiency.
- Output HTML and PDF files.
- Various themes: Cadmium Light, Material Dark etc.
- Various editing modes: Source Code mode, Typewriter mode, Focus mode.
- Paste images directly from clipboard.
:crescent_moon:themes:high_brightness:
Cadmium Light | Dark |
---|---|
Graphite Light | Material Dark |
Ulysses Light | One Dark |
:smile_cat:Edit modes:dog:
Source Code | Typewriter | Focus |
---|---|---|
Why make another editor?
- I love writing. I have used a lot of markdown editors, yet there is still not an editor that can fully meet my needs. I don't like to be disturbed when I write by some unbearable bug. MarkText uses virtual DOM to render pages which has the added benefits of being highly efficient and being open source. That way anyone who loves markdown and writing can use MarkText.
- As mentioned above, MarkText is completely free and open source and will be open source forever. We hope that all markdown lovers will contribute their own code and help develop MarkText into a popular markdown editor.
- There are many markdown editors and all have their own merits, some have features which others don't. It's difficult to satisfy each markdown users' needs but we hope MarkText will be able to satisfy each markdown user as much as possible. Although the latest MarkText is still not perfect, we will try to make it as best as we possibly can.
Download and Installation
Want to see new features of the latest version? Please refer to CHANGELOG.
macOS
You can either download the latest marktext-%version%.dmg
from the release page or install MarkText using homebrew cask. To use Homebrew-Cask you just need to have Homebrew installed.
brew install --cask mark-text
Windows
Simply download and install MarkText via setup wizard (marktext-setup-%version%.exe
) and choose whether to install per-user or machine wide. Alternatively, install MarkText using a package manager such as Chocolatey or Winget.
To use Chocolatey, you need to have Chocolatey installed:
choco install marktext
To use Winget, you need to have Winget installed:
winget install marktext
Linux
Please follow the Linux installation instructions.
Other
All binaries for Linux, macOS and Windows can be downloaded from the release page. If a version is unavailable for your system, then please open an issue.
Development
If you wish to build MarkText yourself, please check out our build instructions.
If you have any questions regarding MarkText, you are welcome to write an issue. When doing so please use the default format found when opening an issue. Of course, if you submit a PR directly, it will be greatly appreciated.
Integrations
- Alfred Workflow: A Workflow for the macOS app Alfred: Use "mt" to open files/folder with MarkText.
Contribution
MarkText is in development, please make sure to read the Contributing Guide before making a pull request. Want to add some features to MarkText? Refer to our roadmap and open issues.
Contributors
Thank you to all the people who have already contributed to MarkText[contributors].
Special thanks to @Yasujizr who designed the MarkText logo.
License
MIT.
Top Related Projects
Universal markup converter
The Markdown-based note-taking app that doesn't suck.
A personal knowledge management and sharing system for VSCode
A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: http://trello.com/b/8txSM12G/roadmap
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot