AzubiMark is a modern, beautiful, and feature-rich Markdown viewer for Android, designed with Material You to provide an immersive and enjoyable reading experience. It is built to be fast, efficient, and easy to use, supporting a wide range of Markdown features to make your documents look their best.
- Stunning Material You Design: A modern and adaptive UI that embraces the latest Android design principles with dynamic theming.
- Comprehensive Markdown Support:
- Tables: Renders structured data with ease.
- Task Lists: Keep track of your to-dos with interactive checkboxes.
- Strikethrough: Emphasize changes and completed items.
- Syntax Highlighting: Code blocks come alive with beautiful and accurate highlighting for numerous languages.
- Built-in File Browser: Navigate your device's storage to find and open Markdown files without leaving the app.
- Dynamic Theme Switcher: Seamlessly switch between Light, Dark, and Material You themes to match your preference.
- Open Files from Anywhere: Launch
.mdand.markdownfiles directly from your file manager, email, or any other app.
(Coming Soon!)
To get started with AzubiMark, you can either build the app from the source or wait for the official release.
- Android Studio: Make sure you have the latest version of Android Studio installed.
- Android Version: Requires Android 8.0 (API 26) or higher.
- Git: You'll need Git to clone the repository.
- Clone the repository:
git clone https://github.com/kelexine/azubimark.git
- Open in Android Studio:
- Launch Android Studio.
- Select File > Open and navigate to the cloned repository directory.
- Sync Gradle:
- Let Android Studio sync the project and download the required dependencies.
- Run the App:
- Connect your Android device or start an emulator.
- Click the Run button in Android Studio to build and install the app.
- UI:
- Jetpack Compose & ViewBinding: For building a modern and interactive UI.
- Material 3 (Material You): To deliver a beautiful and dynamic user experience.
- Markdown Processing:
- Markwon: A powerful library for parsing and rendering Markdown.
- Prism4j: For elegant and efficient syntax highlighting.
- Core Components:
- AppCompat & ConstraintLayout: For compatibility and flexible layouts.
- AndroidX DocumentFile API: For seamless file access and management.
- Kotlin: The project is written entirely in Kotlin, following modern best practices.
Contributions are always welcome! Whether you want to fix a bug, add a new feature, or improve the documentation, your help is greatly appreciated. Please feel free to open an issue or submit a pull request.
This project is licensed under the MIT License. See the LICENSE file for more details.
Franklin Kelechi (kelexine)
- GitHub: @kelexine
Thank you for your interest in AzubiMark! I hope you enjoy using it as much as I enjoyed building it.