marktext / marktext

📝A simple and elegant markdown editor, available for Linux, macOS and Windows.

MarkText

🔆 Next generation markdown editor 🌙
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

_{Translations:} 🇨🇳 🇹🇼 🇵🇱 🇯🇵 🇫🇷 🇹🇷 🇪🇸 🇵🇹 🇰🇷

_{This Markdown editor that could. Built with ❤︎ by Jocs and contributors .}

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.

🌙themes🔆

Cadmium Light	Dark
Graphite Light	Material Dark
Ulysses Light	One Dark

😸Edit modes🐶

Source Code	Typewriter	Focus

Why make another editor?

1. 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.
2. 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.
3. 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.

• User documentation
• Developer documentation

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.

marktext's Issues

Application crash

Description

If I start the app I get an application crash on master. See image below.

Versions

• Mark Text: latest master
• OS: Windows 10

Rejected by McAfee and Fails VirusTotal

McAfee Uninstalls MarkText + VirusTotal finds Ad-Ware package

[Description of the bug or feature]

Steps to reproduce

1. Install software
2. McAfee checks files
3. McAfee uninstalls software and shows message regarding concerns for URLs MarkText is trying to connect to.
4. VirusTotal scan shows up an Ad-Ware package included with your program. This is possibly a false positive as the other scanners shows clean files.

Latest version

• Mark Text: Latest version as of 17 March 2018
• OS: Windows 10 Pro - fully up to date

Theme setting is not being saved

Description

I changed my theme setting to dark and after I restarted Mark Text the theme setting switched back to white. This is a bit annoying because I always have to change the theme whenever I open Mark Text.

Steps to reproduce

1. Click on the hamburguer menu on the top left corner
2. Go to "Theme"
3. Select "Dark"
4. Restart Mark Text

Expected behavior:

Theme setting is persisted after restart.

Actual behavior:

Theme setting is not persisted after restart.

Versions

• Mark Text: 0.7.17
• OS: Windows 10 Version 1709 Build 16299.309

[Enhancement] add logger and kill process after error

To better track down errors you should implement a better logger for such crashes and make sure the marktext processes are killed.

I think you need a Windows PC or a good VM.

hope can have portable version (windows

Description

希望能有免安裝版
另外是不是沒有類似工具列的東西? (好像沒看見

或者也許可以考慮像 Haroopad 一樣
有類似這種可以直接點擊的

Steps to reproduce

1. [First step]
2. [Second step]
3. [and so on...]

Expected behavior: [What you expected to happen]

Actual behavior: [What actually happened]

Link to an example: [If you're reporting a bug that's not reproducible, please try to reproduce it on JSFiddle, JS Bin, CodePen or a similar service and paste a link here]

Versions

• Mark Text: marktext-setup-0.6.14.exe
• OS: windows 10 1709

Can't install with brew cask

using commnad brew cask install mark-text on mac, i don't get install the app.

'<' char will break the file on next open

Description

Double bug in one here :

• When you open a file containing a < in a code block followed by a-Z char, All the text will be deleted after the < occurrence till the end of line. Then the file is automatically saved and so you lose the line content forever.

Steps to reproduce

1. create a file with the following

`if ( itemCount < s ) // some comment ` : followed by a space is good

`if ( itemCount <s ) // some comment ` : followed by a char from alphabet will truncate the line

2. open this file using Marktext
3. second line is truncated
4. file is saved with truncated altered content

Expected behavior: [What you expected to happen]

• Marktext should correctly handle <
• Marktext shouldn't save the file directly after open command but only on user input (ctrl-s or autosave when typing)

Actual behavior: [What actually happened]

• File is altered

Versions

• Mark Text: 0.6.14
• OS: Windows 10

Table menu bug

Description

The table menu icon disappears and you can move the menu 🙈.

Steps to reproduce

problem 1 (fixed)

1. create table
2. press Ctrl+A
3. press Del
4. table icon disappears

problem 2

1. create table
2. press Ctrl+A
3. press (multiple times) Enter
4. table menu position changes and you cannot click on the table anymore

problem 3

1. create table
2. insert new line after the table
3. select table cell
4. press Ctrl+A
5. press Del
6. table disappears

StateRender.js?8779:formatted:140 Uncaught TypeError: Cannot read property 'align' of undefined
    at renderBlock (StateRender.js?8779:formatted:140)
    at eval (StateRender.js?8779:formatted:170)
    at Array.map (<anonymous>)
    at renderBlock (StateRender.js?8779:formatted:169)
    at eval (StateRender.js?8779:formatted:170)
    at Array.map (<anonymous>)
    at renderBlock (StateRender.js?8779:formatted:169)
    at eval (StateRender.js?8779:formatted:170)
    at Array.map (<anonymous>)
    at renderBlock (StateRender.js?8779:formatted:169)

if (block.type === 'li' && block.label) { <--- error
          const { label } = block
          const { align } = activeBlocks[0]

          if (align && block.label === align) {
            blockSelector += '.active'
          }
          Object.assign(data.dataset, { label })
        }

problem 4 (fixed)

1. create table
2. insert new line after table
3. select table cell
4. press Ctrl+A
5. press Backspace
6. press Ctrl+A
7. press Backspace

Uncaught TypeError: Cannot read property 'textContent' of undefined
    at checkEditLanguage (language.js?430e:5)
    at HTMLDivElement.handler (index.js?981b:190)

/**
 * check edit language
 */
export const checkEditLanguage = (paragraph, selectionState) => {
  const text = paragraph.textContent <--- error
  const { start } = selectionState
  const token = text.match(/(^`{3,})([^`]+)/)

  if (token) {
    const len = token[1].length
    const lang = token[2].trim()
    if (start < len) return false
    if (!lang) return false
    return lang
  } else {
    return false
  }
}

// WEBPACK FOOTER //
// src/editor/codeMirror/language.js

Versions

• Mark Text: 0.8.8
• OS: linux

The vertical table line isn't visible in the dark theme.

Description

[The vertical table line isn't visible in the dark theme.]

Versions

• Mark Text: 0.7.17
• OS: Windows 7

Emoji at the begining of header doesn't work

'###:ssmile:' doesn't work

End of the Line in Windows

When creating a .txt file with marktext, end of the line is not recognized if file is opened with Windows Notepad. All text is on a single line.

• Mark Text: latest release
• OS: Windows 10

I can't write chinese in inline code

I can't write chinese in inline code

[I can not write 中文 in aganippe]

Cannot export PDF in Source Code mode

Description

I use mark-text with downloading Linux AppImage file. I am using Unbuntu 16.04, and I open a new file to write something. If I enable View -> Source Code setting, I can't export file as PDF.

[Description of the bug or feature]
Can't export file as PDF when enable source code setting in view.

Steps to reproduce

1. [First step]
2. [Second step]
3. [and so on...]

Expected behavior: [What you expected to happen]
When I click export as PDF , should open a window ask me store the file in where.

Actual behavior: [What actually happened]
Nothing happened after I clicked export as PDF.

Versions

• Mark Text: Linux latest version
• OS: Ubuntu 16.04.4 LTS (Xenial Xerus)

code fence in list and block quote can not work properly

As title

Feature: make rows and columns in table block draggable

This can be a touchable/dragable helper icon on the left of the element (code block, table, etc) or a helper menu above the element

View is broken after drag and drop

Description

Drag and drop don't work and destroys the editor.

Steps to reproduce

1. Write markdown file (and exit editor)
2. Drag and drop markdown file into the editor
3. Editor view is broken

Expected behavior:

When the drag and drop event is accepted, the file should be loaded as markdown.

Actual behavior:

Editor view is broken. You cannot edit text anymore and the tilebar disappears on windows. Furthermore the editor cannot be closed, until you send force kill.

Images

Working editor (open...):

Drag and drop on Linux (Gnome):

Drag and drop on Windows:

Versions

• Mark Text: 0.7.17
• OS: Linux (Gnome) and Windows 10

Disable editor while dialog is shown

Description

Feature/bug? 🦋

Steps to reproduce

Versions

• Mark Text: latest
• OS: linux

Provide homebrew formula

Nice project! Are you considering to provide a homebrew (cask) formula anytime soon?

Notepad option gone from the context menu

Description

[Description of the bug or feature]

Hi.
This is a simple and straightforward thing. After installing and testing Mark Text, I've noticed that the "Text Document" option from the New menu, in the Windows Explorer context menu (right click) has gone. It only came back after uninstalling Mark Text and rebooting the system. I realize this tool is a good alternative to Notepad, but I don't really like having my options taken away from me.

• Mark Text:
• OS:Windows 10 (64-bit)

Windows defender warning

I downloaded and started the latest version for Windows just now, 0.7.17. I have not installed Marktext before.

Windows Defender complained that it was unsafe to install this. Have anyone more seen this?
(It doesn't feel good to click on "Run anyway"...)

Regards
Henrik

Start MarkText with a specific markdown document

Description

I am using MarkText as AppImage on Ubuntu Linux. When I pass a filename as a command line parameter to MarkText.AppImage it just starts with a blank document. Therefore I cannot integrate it in desktop environment nicely, like opening markdown documents in MarkText with a double-click.

Steps to reproduce

1. Download latest MarkText.AppImage on Linux and make it executable
2. Start it from the command line passing a path and name of existing markdown document as a parameter

Expected behavior: MarkText starts with this markdown document open

Actual behavior: MarkText starts with a blank document

Versions

• Mark Text: marktext-0.7.17-x86_64.AppImage
• OS: Ubuntu Linux 17.04

怎么输出成pdf呢？theme怎么切换呢？输入模式怎么切换呢？linux系统

Description

[Description of the bug or feature]
快捷键

Steps to reproduce

快捷键使用

Versions

• Mark Text:
• OS:linux

Aidou dialog background

Description

Aidou dialog background is not transparent and I cannot click on this area to hide the dialog. Even if I set the background is none or transparent.

Steps to reproduce

Switch to dark theme and open aidou dialog.

Expected behavior:

Transparent background and I can easily hide the dialog.

Actual behavior:

Versions

• Mark Text: latest
• OS: linux

Emoji name with `_`, will be treat as emphasize syntax

when I write emoji name 1s\_place\_medio, it will be treat as emphasize syntax.

[it is a bug]

Steps to reproduce

1. [input :1s_place_madal:]
2. [I didn't get 🥇 ]
3. [but got 1splacemadal]

Missing preferences menu

The "Marktext" application menu is not shown on OSs other than OSX. Maybe we could move the preferences entry into file or edit menu, so that you can edit preferences on Linux and Windows?

Versions

• Mark Text: latest
• OS: not OSX

Mark Text doesn't save selected theme

Description

Mark Text doesn't save the selected theme, perhaps there could be a user config file.

Steps to reproduce

1. Change Theme
2. Reopen Mark Text

Expected behavior:
Mark Text should keep selected theme

Actual behavior:
Mark Text doesn't keep selected theme

Versions

• Mark Text: 0.6.14
• OS: Windows 10 x64

Windows: Wrong context menu position

Description

The context menu (which replaced the menu bar) is opened on random positions on the screen - sometimes outside the editor. The bug appears mostly on second monitor.

Images

Versions

• Mark Text: 0.7.17
• OS: Windows 10 dual monitors

export as Styled HTML error 2

Description

When export as Styled HTML, the symbol which should be just existed in editor was exported to HTML file.

Steps to reproduce

1. Type some content:

2. Export file as Styled HTML:

3. Open file in browser (Chrome or Safari):

Expected behavior: Couldn't see the symbol in exported file.
Actual behavior: The symbol is displayed in the exported file.

Link to an example: Append my file below:

# Title

javascript

```
function add (a, b) {
  return a + b;
}
```

sh

```
sudo chmod +x yourfile.js
./yourfile.js
```

python

```
def func (a, b) {
  return a * b;
}
```

Versions

• Mark Text: 0.6.14.117
• OS: macOS 10.13.3

Broken syntax highlighting in code blocks after re-import

It is currently impossible to re-import a project without loosing syntax highlighting. That's truly disappointing. Fix this, please.

This is what happens after re-import:

Should be
```scala
sealed trait Tree[+A]
```
instead of plain:
```
sealed trait Tree[+A]
```

New Design

Hi, I have studied your work and I think a new logo will make you more visible. I designed a logo for you, I hope you like it and you want to use it. If you contact me here or from [email protected] I can give you all the formats of the logo. If you want a change please specify.

Shortcut for Typewriter Mode triggers Terminal in Linux/Ubuntu

Description

Great job on this markdown editor.

The current shortcut for Typewriter mode on Linux (Ctrl + Alt + T) unfortunately brings up the terminal. Consider changing the shortcut.

Steps to reproduce

1. Load Mark Text on a Linux system
2. Hit Ctrl + Alt + T

Expected behavior:
Mark Text enters Typewriter mode

Actual behavior: [What actually happened]
Linux boots up the terminal

Versions

• Mark Text: 0.6.14
• OS: Ubuntu 16.04

Quick Question: Electron App right? Why not for Windows?

Hey @marktext,

Since this app is an Electron App, why don't you consider releasing for Windows and Linux too? I can help you if you need. 😸

Cheers!

TODOLIST: Add rename (custom top dialog)

Description

TODOLIST: Add option to rename the file

Because electron's default dialog which is used for actions on the file is not capable of displaying a text field, a custom dialog is needed.

I have developed a custom top dialog inspired by macOS' dialog and tried to keep the minimalistic design of marktext. The dialog I created can not only be used to show rename dialog but can be used to create any custom dialog.
If you want changes to the design just comment, and I will implement them. That's why I first wanted to post an issue. I also still have to write tests for it. If you like I can then implement 'move to' as well.

Link to an example: You can have a look at it, in this fork (dev branch): https://github.com/DXXL/marktext

Open with not working on Win

Description

Mark Text does not support Windows "Open with.." feature.

Steps to reproduce

1. Associate .md files with Mark Text/
2. Open md file
   or run "C:\Program Files\Mark Text\Mark Text.exe" README.md in a folder with a README.md file

Expected behavior: Open that md file

Actual behavior: blank page

Versions

• Mark Text: 0.6.14
• OS: Win10 64 Bit, Win7 64 Bit

Feature: ability to insert an empty line between elements

Say, we have a code block and a table following right after the code block, right in the next line. In this case, we have a problem: inability to insert an empty line or anything else between the code block and the table.

[suggetion] flatpak build

Hi guys,

I love your app :) Thanks for this 👍

Is it possible to add a flatpak build? Im using Deepin OS and this distribution is using flatpak.

Is that an easy step, or a complex one?

export as Styled HTML error

Description

When export the document as Styled HTML, then open the exported HTML file in browser, the code part display wrong even couldn't scroll.

Steps to reproduce

1. Type some content, insert a piece of code, like below:

2. Export the file as Styled HTML, operate step: file => Export => Styled HTML

3. Open it in browser (Chrome or Safari), will be this:

Expected behavior: Display in right way, at least could scroll in code area

Actual behavior: Part of code was hidden and could not scroll in code area

Link to an example: Append my file content below:

# Title

javascript

```javascript
function add (a, b) {
  return a + b;
}
```

sh

```sh
sudo chmod +x yourfile.js
./yourfile.js
```

python

```python
def func (a, b) {
  return a * b;
}
```

Versions

• Mark Text: 0.6.14.117
• OS: macOS 10.13.3

Change install path so that Admin rights aren't required. [Window]

Description

Hey thanks for the app, it looks great. Is there any way you could think about changing the default installation directory from C:\Program Files\ to a less privileged location. I would love to install the app on my work laptop but don't have admin rights. Another option would be to make the installation path configurable.

Steps to reproduce

1. Download Windows binary and try to install.
2. Installation prompts for admin login

Expected behavior: [What you expected to happen]

Download binary and try to install, program installs either to a user directory (e.g. C:\Users$USER\AppData\Roaming) or prompts for install path.

Versions

• Mark Text: v.0.6.14
• OS: Windows 7

Hope: provide brew cask install

Hope:

brew cask install marktext;

wdf!!Thanks

Icon Color

I was wondering if you can change the color/s of the icon, because it doesn't look good on a dark background (for example: I'm using Win10 dark theme, and I can't see the icon when I pinned it to the task bar).

Thank you 💯

There is not an integration with the user interface Kde

Description

On Kde Neon I've seen a bad integration with the window drawer, it ts not showing the window bar with close, minimize and maximize buttons.

Steps to reproduce

1. Open Mark Text on Kde neon
2. Look to the window bar

Expected behavior: Window buttons showing, like in firefox:

Actual behavior: Window buttons do not show:

Versions

• Mark Text: v 0.6.14
• OS: Kde neon based on ubuntu 16.04

can not insert an image into a link

[![](./picture/path/image.png)](http://www.other.com) syntax can not work

Menu bar broken latest Dev build on windows

On the latest source the menu bar at the top is broken and replaced by a context menu.

Installing as default editor

Description

After installing all text (.txt) files changed to MarkText icon causing any of those files to be opened by this app due to it automatically changing the default.

Steps to reproduce

1. Install
2. Look at the icon for any text (.txt) file in a directory

Expected behavior:
Not to change default application settings without permission.

Actual behavior:
Default changed to MarkText for text files. Users may have other editors (as I do) for editing such as Notepad++, Editpad, Vim, etc. which they may prefer to remain default, especially when one is just trying out the software. A user should be asked which file formats they want associated with the app, if any. Shouldn't assume they want to change or, are giving up their current tool(s).

Link to an example:
None required.

Versions

• Mark Text: v0.7.17
• OS: Windows 7 x64

Support tight lists

MarkText should support tight lists. Currently all lists are converted to loose ones.

* Foo
* Bar

After:
* Foo

* Bar

As discussed here: #30 (comment)

Automatically save option

Hi, thanks for your work! Can we please have the option to disable automatically save after editing text?

Thanks!

Consider the situation when paste Richtext copied from other place

Should inline css be removed or not?

Add MathJax support

Description

It would be nice to have MathJax integration (to allow to display mathematics in MarkDown),
in the same way pandoc does.

Expected behavior: Allow editing the formula and render it once the focus leaves it (I'm not really sure about the terminology).

Link to a library: I found mathjax-electron which seems to allow to do what I suggest.

If you give me some guidance, I could do a pull request, but I don't really know where to begin.

Add sidebar feature: filebrowser, outlines and tabs

Description

[Add sidebar feature: filebrowser, outlines and md-syntax-list]

Versions

• Mark Text: 0.7.17
• OS: windows 7

Hitting Tab key causes cursor to disappear or move somewhere along the UI

Steps to reproduce

1. open up a document and type something
2. hit the tab key
3. watch cursor disappear

Expected behavior: cursor shifts a tab width (or 2 or 4 spaces) ahead

Actual behavior: cursor disappears

Versions

• Mark Text: 0.6.14.117
• OS: Mac OS 10.12.6