twilight-shuxin / markor

Text editor - Notes & ToDo (for Android) - Markdown, todo.txt, plaintext, math, ..

Markor

Text editor - Notes & ToDo (for Android).
Simple and lightweight, supporting Markdown, todo.txt, Zim & more!

Markor is a TextEditor for Android. This project aims to make an editor that is versatile, flexible, and lightweight. Markor utilizes simple markup formats like Markdown and todo.txt for note-taking and list management. It is versatile at working with text; it can also be used for keeping bookmarks, copying to clipboard, fast opening a link from text and lots more. Created files are interoperable with any other plaintext software on any platform. Markor is openly developed free software that accepts community contributions.

Features

📝 Create notes and manage your to-do list using simple markup formats
🌲 Work completely offline -- whenever, wherever
👌 Compatible with any other plaintext software on any platform -- edit with notepad or vim, filter with grep, convert to PDF or create a zip archive

🖍 Syntax Highlighting and format related actions -- quickly insert pictures and to-dos
👀 Convert, preview, and share documents as HTML and PDF

📚 Notebook: Store all documents on a common filesystem folder
📓 QuickNote: Fast accessible for keeping notes
☑️ To-Do: Write down your to-do
🖍 Formats: Markdown, todo.txt, csv, ics, ini, json, toml, txt, vcf, yaml

📋 Copy to clipboard: Copy any text, including text shared into Markor
💡 Notebook is the root folder of documents and can be changed to any location on the filesystem. QuickNote and To-Do are textfiles

🎨 Highly customizable, dark theme available
💾 Auto-Save with options for undo/redo
👌 No ads or unnecessary permissions
🌎 Language selection -- use other language than on the system

🔃 Markor is an offline app. It works with sync apps, but they have to do syncing respectively. Sync clients known to work in combination include BitTorrent Sync, Dropbox, FolderSync, OwnCloud, NextCloud, Seafile, Syncthing, Syncopoli
🔒 Can encrypt your textfiles with AES256. You need to set a password at the settings and use Android device with version Marshmallow or newer. You can use jpencconverter to encrypt/decrypt easily on desktop. Be aware that only the text is encrypted not pictures or attachments.

Contribute

• Programming
  The project is always open for contributions and welcomes merge requests. Take a look at our issue tracker for open issues, especially "good first issues".
• Feature requests & discussions
  Start a discussion here.
• Bug reports
  Report issues here. Please search for similar issues & requests first. If it's not a bug, please head to discussions.
• Localization
  Translate on Crowdin (free).

Develop

Clone the project using git. Then open the project in Android Studio (recommended), install required Android SDK dependencies where required. You may also use any other plaintext editor of your preference.

There is a Makefile in the project which makes it easy to test, lint, build, install & run the application on your device. See the Makefile for reference. You can find binaries (.apk), logs, test results & other outputs in the dist/ directory.
Example: make all install run.

The project code style is the AOSP Java Code Style. Use the auto reformat menu option of Android Studio before commiting or before you create the pull request.

Technologies / Dependencies

• Java, Android SDK, AppCompat
• Editor: Advanced component based on Android EditText
• Preview: Android WebView
• Markdown parser: flexmark-java
• Zim & todo.txt parser: Custom implementation
• CI/CD: GitHub Actions
• Build system: Gradle & Makefile

Resources

• Project repository: Changelog | Issues | Discussions | License | GitHub Releases | Makefile
• F-Droid: Listing | Wiki | Metadata | Build log

Privacy

Markor does not use your internet connection unless your own user-generated content references external resources (for example, when you reference an external image by URL). The app is working completly offline, no internet connection required! No personal data is shared with the author or any third parties (i.e. calendar or contacts). Files can be shared to other apps from inside the app by pressing the share button. Files are stored locally in a user selectable folder, defaulting to the device public documents folder.

Android Permissions

• WRITE_EXTERNAL_STORAGE, READ_EXTERNAL_STORAGE
  Read and write files from/to device storage.
• INTERNET
  In user-generated content data can be loaded from the internet.
• INSTALL_SHORTCUT
  Install a shortcut to launchers to open a file/folder in Markor.
• RECORD_AUDIO
  Attach voice notes to the text. The permission is only used after click on the "attach audio" button, at the audio record dialog. Audio recording is always started and stopped manually by you (button press).

License

The code of the app is licensed Apache 2.0 or Commerical (See LICENSE for details).
Localization & translation files (string*.xml) are licensed CC0 1.0.
Project is based on the unmaintained projects writeily and writeily-pro.