Skip to content

Repository files navigation

MarkReader

CI Downloads F-Droid License: GPL v3

Read Markdown and source code on your phone, rendered the way it was meant to look, with a built-in editor for your notes. No ads, no tracking, no accounts, and no internet access.

Also available on desktop.

Get it on F-Droid

Download the latest APK from the Releases page.

GitHub, F-Droid and Google Play builds are signed with the same key. SHA-256 certificate fingerprint: 1E:09:59:11:C0:34:28:52:0E:8B:60:F7:B9:DB:F4:55:BF:38:58:18:51:6D:9C:15:90:49:68:71:C8:3D:5F:89

Help test on Google Play

We're working on getting MarkReader published on Google Play. The app is already available there in closed testing, and we need real users trying it out to get it fully published.

  1. Join the Google Group (approval may take a few minutes)
  2. Once approved, opt in as a tester
  3. Install the app from Google Play and open it a few times over the next two weeks

Get it on Google Play (testing)

Thank you! This helps us reach far more users than F-Droid and GitHub alone.

Screenshots

Home Screen Markdown Viewer Code, Math and Diagrams Table of Contents Reader Settings Code Viewer in Dark Theme

Features

Reading

  • Markdown rendering - The same engine as MarkReader for desktop, styled after VS Code's Markdown preview, with tables, task lists and fenced code blocks
  • Math and diagrams - LaTeX math with KaTeX, and Mermaid diagrams
  • Front matter - YAML front matter is shown as a table above the document
  • Syntax highlighting - Source files and code blocks highlighted for dozens of languages, including Kotlin, Python, JavaScript, Rust, Ruby, Java, C/C++, HTML, CSS, JSON, YAML and TOML
  • Rendered or raw - Switch any Markdown file between its rendered view and its source
  • Search and outline - Find text in a document and jump between headings from the table of contents
  • Export and share - Export a document as PDF or HTML, or share its source

Editing

  • Built-in editor - Write notes and edit Markdown with a live preview tab
  • Formatting toolbar - Bold, italic, strikethrough, code, links, lists and quotes while you type
  • Save and Save As - Save in place, or save a copy to a new location
  • New files - Start a note or a file from scratch

App

  • Open from anywhere - Open files from any file manager through the standard open and share actions
  • Reader themes - Light, dark, AMOLED and sepia, with your choice of reading font, code font, size, line height and alignment
  • Material You - Material 3 with dynamic color, plus Light, Dark and System themes
  • Fully private - Files are read on your device and never leave it

Requirements

  • Android 7.0 (Nougat) or higher

Permissions

MarkReader requests no permissions. Files are opened through Android's standard content URI system, so no storage permission is needed.

MarkReader has no internet permission.

Building

Requires JDK 17 and the Android SDK (API 36).

git clone https://github.com/usamaiqb/mark-reader.git
cd mark-reader
./gradlew assembleDebug

The APK is written to app/build/outputs/apk/debug/. See CHANGELOG.md for version history.

Translations

Language Progress
English ████████████ 100% (source)
Беларуская ████████████ 96%
Български ████████████ 96%
Bosanski ████████████ 96%
Čeština ████████████ 96%
Deutsch ████████████ 96%
Español ████████████ 96%
Français ████████████ 96%
Hrvatski ████████████ 96%
Македонски ████████████ 96%
Polski ████████████ 96%
Português (Brasil) ████████████ 96%
Русский ████████████ 96%
Slovenčina ████████████ 96%
Slovenščina ████████████ 96%
Српски ████████████ 96%
Українська ████████████ 96%

Translations are welcome! Add or improve one in app/src/main/res/values-<locale>/strings.xml and open a pull request.

Contributing

Contributions are welcome. Use Issues for bugs and questions.

Credits

License notices are in licenses/THIRD_PARTY_LICENSES.md.

License

GNU General Public License v3.0. See the Privacy Policy for how the app handles data.

Releases

Packages

Contributors

Languages