# Muggle

**Repository Path**: ilikecode/Muggle

## Basic Information

- **Project Name**: Muggle
- **Description**: An open source markdown editor for Android. You can use this save your Markdown file to github repositorie.
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-09-07
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center"><img alt="logo" src="https://raw.githubusercontent.com/jixiaoyong/mua/master/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png" width="256" height="256"></p>

# [Muggle](https://en.wikipedia.org/wiki/Muggle) [![Build Status](https://www.travis-ci.org/jixiaoyong/Muggle.svg?branch=master)](https://www.travis-ci.org/jixiaoyong/Muggle) = [Mua](https://github.com/zeleven/mua) + **[`Github`](https://github.com)**

An open source markdown editor for Android.

Base on [Mua](https://github.com/zeleven/mua).

# Foreword

这个项目正在紧张的开发过程中，如果你也感兴趣或者有任何好的想法，请赶快联系我吧。[Issue](<https://github.com/jixiaoyong/Muggle/issues>)，[Email](mailto:jixiaoyong1995+muggle_app@gmail.com)都会是不错的选择ヽ(ﾟ∀ﾟ)ﾒ(ﾟ∀ﾟ)ﾉ

This project is in the process of development. If you are interested or have any good ideas, please contact me. The  [Issue](<https://github.com/jixiaoyong/Muggle/issues>) or [Email](mailto:jixiaoyong1995+muggle_app@gmail.com) will be a good choiceヽ(ﾟ∀ﾟ)ﾒ(ﾟ∀ﾟ)ﾉ

# TODO

- [x] `fix` Support Android 9

- [x] `add` Save file in github repositories.

See more:[Project](https://github.com/jixiaoyong/Muggle/projects/1)

# Features

* Multi-language support
* GFM support
* Markdown cheat sheet support
* Editor toolbar, that you can insert the markdown code, image, bold, italic and more.
* Menu operation, that allows you save, rename, delete and more.
* Search for files
* Under MIT license

# Dependencies

## Java

* ~~[Butter Knife](https://github.com/JakeWharton/butterknife)~~
* [EventBus](https://github.com/greenrobot/EventBus)
* [BottomSheet](https://github.com/Flipboard/bottomsheet)
* [Android Support library - preference v7 bugfix](https://github.com/Gericop/Android-Support-Preference-V7-Fix)
* [EasyPermissions](https://github.com/googlesamples/easypermissions)
* [RxAndroid](https://github.com/ReactiveX/RxAndroid)
* [retrofit](https://github.com/square/retrofit)
* [glide](https://github.com/bumptech/glide)

## JavaScript

* [marked](https://github.com/chjj/marked)

# Also Thanks

* [Mua](https://github.com/zeleven/mua)
* [WanAndroid](https://github.com/jixiaoyong/WanAndroid)
* [OpenHub](https://github.com/ThirtyDegreesRay/OpenHub)
* [IconFont](https://www.iconfont.cn)
* [GitHub Api](https://developer.github.com/v3/)

# Screenshots

<p float="left">
  <img src="https://github.com/jixiaoyong/mua/blob/master/screenshots/Screenshot_2018-02-04-20-59-05.png" width="240">
  <img src="https://github.com/jixiaoyong/mua/blob/master/screenshots/Screenshot_2018-02-04-20-59-15.png" width="240">
  <img src="https://github.com/jixiaoyong/mua/blob/master/screenshots/Screenshot_2018-02-04-20-59-25.png" width="240">
</p>
<p float="left">
  <img src="https://github.com/jixiaoyong/mua/blob/master/screenshots/Screenshot_2018-02-04-21-00-14.png" width="240">
  <img src="https://github.com/jixiaoyong/mua/blob/master/screenshots/Screenshot_2018-02-04-21-00-17.png" width="240">
  <img src="https://github.com/jixiaoyong/mua/blob/master/screenshots/Screenshot_2018-02-04-21-00-21.png" width="240">
</p>
<p float="left">
  <img src="https://github.com/jixiaoyong/mua/blob/master/screenshots/Screenshot_2018-02-04-21-00-32.png" width="240">
  <img src="https://github.com/jixiaoyong/mua/blob/master/screenshots/Screenshot_2018-02-04-21-07-44.png" width="240">
  <img src="https://github.com/jixiaoyong/mua/blob/master/screenshots/Screenshot_2018-02-04-21-08-42.png" width="240">
</p>
<p float="left">
  <img src="https://github.com/jixiaoyong/mua/blob/master/screenshots/Screenshot_2018-02-04-21-09-14.png" width="240">
</p>

# In Addition | 声明

这个库中没有版权声明的文件大多都是[Mua](https://github.com/zeleven/mua)的作者zeleven编写的，其中有一部分文件可能被我进行了必要的改动，原作者zeleven对于这部分文件的保留所有可能的权益，我并不保证这些文件与原作者的内容完全一致，也不保证原作者赞同或不赞同这些更改。如果想要查看这期间发生的改动，请手动对比这两个库的异同。

Here is the Google translation of this paragraph statement(For reference only). | 下面是本段声明对应的Google翻译（仅供参考）。

Most of the files in this library that have no copyright notices are written by zeleven, the author of [Mua](https://github.com/zeleven/mua). Some of the files may have been modified by me. The original author zeleven retains all possible interests in this section of the document, but I do not guarantee that the documents are identical to the original author's content, nor does it guarantee that the original author agrees or disagrees with the changes. If you want to see the changes that have occurred during this period, manually compare the similarities and differences between the two libraries.

# License

Under MIT license, check the [license file](https://github.com/jixiaoyong/mua/blob/master/LICENSE) for more detail.