Skip to content

Renakoni/marktext-android

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

143 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

MarkText for Android logo

MarkText for Android

Markdown, quietly.

A focused editor for Android β€” the desktop MarkText experience, shaped for the phone.

License: MIT Β  Android 7.0+ Β  Latest release

Highlights Β· Build from source Β· License

Editing a Markdown document β€” light theme            The same document in a dark theme

β˜€Β  Light Β Β·Β  Dark  ☾  β€” whichever your system prefers

Note

Unofficial community port β€” not affiliated with, endorsed by, or maintained by the MarkText team. It builds on and modifies MarkText's open-source editor core (Muya) for Android; see License & attribution.

What it is

MarkText for Android brings MarkText's live-preview Markdown editing to the phone, without rewriting it as a native app. Its editor is Muya, MarkText's open-source core, heavily adapted for mobile: faster on large documents, re-laid-out for a phone's width, and given the touch selection and toolbars a desktop never needed. What you write renders with the same fidelity as on desktop, in an interface built for one hand.

Highlights

A lightweight Markdown editor that never loses a word

  • True live-preview (WYSIWYG) editing β€” the desktop MarkText writing experience, not a plain text box.
  • Full CommonMark and GitHub Flavored Markdown: math (KaTeX), tables, footnotes, front matter, diagrams, and syntax-highlighted code.
  • A document outline and in-editor search that stay smooth even in long files.
  • Export to PDF with math, code highlighting, and fonts all baked in.
  • Never loses your work. Autosave and recovery drafts keep every change, and atomic, all-or-nothing writes mean an interrupted save never leaves a half-written or corrupted file.
  • Private by default. No account, no cloud, no telemetry; everything stays on the device.
  • Lightweight. A focused Vue + Capacitor shell rather than a heavy native stack keeps the whole app around 7.8 MB β€” small and light, yet fully featured.
Tables, code, and math rendered live while typing

Make it yours

The docked format toolbar and a customized selection (paste) bar shown while editing

Customization runs deep here, right down to the bars you touch while writing:

  • Build your own toolbars. Compose the bottom quick bar from a pool of commands and drag to reorder it. Even the selection toolbar β€” the clipboard bar that appears over highlighted text β€” can hold your own commands, in one row or two.
  • Themes and type. Light, dark, and custom themes (ayu-light, one-dark); adjustable font family, size, line height, line width, and text direction (LTR or RTL).
  • Markdown to your taste. List markers and indentation, heading style, front matter format (YAML/TOML/JSON), footnotes, super/subscript, HTML rendering, and GitLab compatibility.
  • File-level control. Per-document encoding, line endings, and trailing newline handling.

Built for the phone, polished for everyone

The editor showing a Chinese document with a Chinese interface
  • Your files stay put. Edit .md straight from any storage provider through the system picker, and pass documents to and from other apps with the share sheet β€” no import/export shuffle, no second copy in a sandbox.
  • Made for the thumb. Comfortable one-handed reach and a calm, editor-first layout, with wide tables that scroll on their own instead of shifting the page.
  • Accessible and restrained. A quiet graphite design that meets WCAG 2.2 AA, with visible focus order and respect for reduced-motion.
  • Ten languages, chosen automatically from your system: English, German, Spanish, French, Japanese, Korean, Portuguese, Turkish, and Simplified and Traditional Chinese.

Project status

Important

The first signed public release, v0.1.0, is available. Its APK is built by the repository's release workflow, pinned to the official release certificate, and has passed clean-install and same-key upgrade checks on Android 14.

Download signed builds from the Releases page.

Build from source

You'll need Node.js with pnpm and Android Studio (Android SDK β€” min API 24, target 36 β€” and a JDK).

pnpm install          # install dependencies
pnpm dev              # preview the web shell in a browser
pnpm android:sync     # build the web app and sync it into the Android project
pnpm android:open     # open it in Android Studio, then run on a device or emulator

Other scripts (test, lint, typecheck, build) are in package.json. Release maintainers should follow docs/RELEASING.md.

Tip

The Markdown editor core is a vendored, modified copy of @muyajs/core (Muya) under third_party/muya. If you change it, sync your edits into node_modules/@muyajs/core/src/** before building β€” a contract test catches drift.

Contributing

Issues and pull requests are welcome. Keep each change focused, and add tests where they make sense.

License & attribution

MarkText for Android is released under the MIT License.

It is an unofficial port, built on MarkText's open-source work and not affiliated with or endorsed by the MarkText project:

  • MarkText β€” the desktop editor and design this port follows. Copyright Β© Luo Ran and the MarkText contributors, MIT licensed.
  • Muya (@muyajs/core) β€” the editor core, vendored and modified under third_party/muya with its original MIT license kept (third_party/muya/LICENSE).

Acknowledgements

MarkText for Android stands on a lot of open-source work: the MarkText editor and its contributors, the Muya editing engine, and Vue, Vite, and Capacitor. Thank you to everyone who built them.


Markdown, quietly.

About

πŸ“± A quiet, focused Markdown editor for Android β€” an unofficial port of MarkText .

Topics

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors