Skip to content

Latest commit

 

History

History
362 lines (276 loc) · 11 KB

README-zh-rCN.md

File metadata and controls

362 lines (276 loc) · 11 KB
Raw

RxMarkdown

License API Android Arsenal

RxMarkdown 是一个运用 RxJava API 在 android.widget.TextView 或 android.widget.EditText 中编辑和（实时）预览基本 markdown 语法的 Android 库，同时支持代码高亮。

注：RxMarkdown 暂时不支持 HTML 标签。

Demo apk : 下载

二维码 : 传送门

更新日志 : 传送门

RxMarkdown.gif

Gradle

implementation 'com.yydcdut:markdown-processor:0.1.3'
implementation 'com.yydcdut:rxmarkdown-wrapper:0.1.3'

或者不想使用 RxJava 的话，直接引用 markdown-processor 即可：

implementation 'com.yydcdut:markdown-processor:0.1.3'

支持语法

RxMarkdown 目前提供两种解析 markdown 的解析方式， TextFactory 和 EditFactory 。

TextFactory : 支持大部分语法，但是会破坏内容的完整性，适用于解析后在 TextView 中渲染。

EditFactory : 支持部分语法，不会破坏内容的完整性且速度比 TextFactory 快，适用于在 EditView 中实时预览。

TextFactory

  • 标题 # / ## / ### / #### / ##### / #######
  • 区域引用 >
  • 嵌套区域引用 > >
  • 粗体 ** __
  • 斜体 * _
  • 粗体和斜体嵌套
  • 有序列表 1.
  • 嵌套有序列表
  • 无序列表 * / + / -
  • 嵌套无序列表
  • 图片 ![]()
  • 链接 []()
  • 行内代码
  • 代码区块
  • 反斜杠 \
  • 分割线 *** / ***** / --- / -----------------
  • 删除线 ~~
  • 注脚 [^]
  • Todo - [ ] / - [x]
  • 表格 | 表格 | 表格 |
  • 代码高亮

其他语法

  • 居中 [ ]

EditFactory

  • 标题 # / ## / ### / #### / ##### / #######
  • 区域引用 >
  • 嵌套区域引用 > >
  • 粗体 ** __
  • 斜体 * _
  • 粗体和斜体嵌套
  • 有序列表 1.
  • 嵌套有序列表
  • 无序列表 * / + / -
  • 嵌套无序列表
  • 图片 ![]()
  • 链接 []()
  • 行内代码
  • 代码区块
  • 反斜杠 \
  • 分割线 *** / ***** / --- / -----------------
  • 删除线 ~~
  • 注脚 [^]
  • Todo - [ ] / - [x]
  • 表格 | 表格 | 表格 |
  • 代码高亮

其他语法

  • 居中 [ ]

HtmlFactory

//TODO

开始

引用

implementation 'com.yydcdut:markdown-processor:0.1.3'
implementation 'com.yydcdut:rxmarkdown-wrapper:0.1.3'

implementation 'io.reactivex:rxandroid:1.2.0'
implementation 'io.reactivex:rxjava:1.1.5'

配置

RxMDConfiguration 的作用是告诉 RxMarkdown 如何展示 markdown 内容。

RxMDConfiguration#Builder 中的所有参数都是非必须的，只需要配置所需要的便可，没有配置的会设置上默认值（RxMDConfiguration#Builder 和 MarkdownConfiguration#Builder 使用方式一样）。

RxMDConfiguration rxMDConfiguration = new RxMDConfiguration.Builder(context)
        .setHeader1RelativeSize(1.6f)//default relative size of header1
        .setHeader2RelativeSize(1.5f)//default relative size of header2
        .setHeader3RelativeSize(1.4f)//default relative size of header3
        .setHeader4RelativeSize(1.3f)//default relative size of header4
        .setHeader5RelativeSize(1.2f)//default relative size of header5
        .setHeader6RelativeSize(1.1f)//default relative size of header6
        .setBlockQuotesLineColor(Color.LTGRAY)//default color of block quotes line
        .setBlockQuotesBgColor(Color.LTGRAY, Color.RED, Color.BLUE)//default color of block quotes background and nested background
        .setBlockQuotesRelativeSize(Color.LTGRAY, Color.RED, Color.BLUE)//default relative size of block quotes text size
        .setHorizontalRulesColor(Color.LTGRAY)//default color of horizontal rules's background
        .setHorizontalRulesHeight(Color.LTGRAY)//default height of horizontal rules
        .setCodeFontColor(Color.LTGRAY)//default color of inline code's font
        .setCodeBgColor(Color.LTGRAY)//default color of inline code's background
        .setTheme(new ThemeDefault())//default code block theme
        .setTodoColor(Color.DKGRAY)//default color of todo
        .setTodoDoneColor(Color.DKGRAY)//default color of done
        .setOnTodoClickCallback(new OnTodoClickCallback() {//todo or done click callback
        	@Override
        	public CharSequence onTodoClicked(View view, String line) {
                return textView.getText();
        	}
        })
        .setUnOrderListColor(Color.BLACK)//default color of unorder list
        .setLinkFontColor(Color.RED)//default color of link text
        .showLinkUnderline(true)//default value of whether displays link underline
        .setOnLinkClickCallback(new OnLinkClickCallback() {//link click callback
        	@Override
        	public void onLinkClicked(View view, String link) {
        	}
        })
        .setRxMDImageLoader(new DefaultLoader(context))//default image loader
        .setDefaultImageSize(100, 100)//default image width & height
        .build();

使用 (Rx)

  • RxMDEditText 实时预览

    RxMarkdown.live(rxMDEditText)
        .config(rxMDConfiguration)
        .factory(EditFactory.create())
        .intoObservable()
        .subscribe();

  • 取消实时预览

    rxMDEditText.clear();

  • RxMDTextView 预览

    RxMarkdown.with(content, this)
        .config(rxMDConfiguration)
        .factory(TextFactory.create())
        .intoObservable()
        .subscribeOn(Schedulers.computation())
        .observeOn(AndroidSchedulers.mainThread())
        .subscribe(new Subscriber<CharSequence>() {
            @Override
            public void onCompleted() {}

            @Override
            public void onError(Throwable e) {}

            @Override
            public void onNext(CharSequence charSequence) {
                rxMDTextView.setText(charSequence, TextView.BufferType.SPANNABLE);
            }
        });

使用 (非 Rx)

  • MarkdownEditText 实时预览

    MarkdownProcessor markdownProcessor = new MarkdownProcessor(this);
markdownProcessor.config(markdownConfiguration);
markdownProcessor.factory(EditFactory.create());
markdownProcessor.live(markdownEditText);

  • 取消实时预览

    markdownEditText.clear();

  • MarkdownTextView 预览

    MarkdownProcessor markdownProcessor = new MarkdownProcessor(this);
markdownProcessor.factory(TextFactory.create());
markdownProcessor.config(markdownConfiguration);
textView.setText(markdownProcessor.parse(content));

注意

RxMDImageLoader

  • 支持的 URI 格式：

    "http://web.com/image.png" // from Web
"file:///mnt/sdcard/image.png" // from SD card
"assets://image.png" // from assets
"drawable://" + R.drawable.img // from drawables (non-9patch images)

  • 自定义 imageLoader

    public class MDLoader implements RxMDImageLoader {
    @Nullable
    @Override
    public byte[] loadSync(@NonNull String url) throws IOException {
        return new byte[0];
    }
}

图片尺寸

需要在屏幕上显示高度和宽度为 320 * 320 像素的图片：

![image](http://web.com/image.png/320$320)

代码高亮主题

该库提供了一些代码高亮的主题， ThemeDefault, ThemeDesert, ThemeSonsOfObsidian 和 ThemeSunburst。

ThemeDefault ThemeDesert ThemeSonsOfObsidian ThemeSunburst
ThemeDefault ThemeDesert ThemeSonsOfObsidian ThemeSunburst

同时也可以实现 Theme 接口来配置自己想要的主题。

public class CodeHighLightTheme implements Theme {

    @Override
    public int getBackgroundColor() {//background color
        return 0xffcccccc;
    }

    @Override
    public int getTypeColor() {//color for type
        return 0xff660066;
    }

    @Override
    public int getKeyWordColor() {//color for keyword
        return 0xff000088;
    }

    @Override
    public int getLiteralColor() {//color for literal
        return 0xff006666;
    }

    @Override
    public int getCommentColor() {//color for comment
        return 0xff880000;
    }

    @Override
    public int getStringColor() {//color for string
        return 0xff008800;
    }

    @Override
    public int getPunctuationColor() {//color for punctuation
        return 0xff666600;
    }

    @Override
    public int getTagColor() {//color for html/xml tag
        return 0xff000088;
    }

    @Override
    public int getPlainTextColor() {//color for a plain text
        return 0xff000000;
    }

    @Override
    public int getDecimalColor() {//color for a markup declaration such as a DOCTYPE
        return 0xff000000;
    }

    @Override
    public int getAttributeNameColor() {//color for html/xml attribute name
        return 0xff660066;
    }

    @Override
    public int getAttributeValueColor() {//color for html/xml attribute value
        return 0xff008800;
    }

    @Override
    public int getOpnColor() {//color for opn
        return 0xff666600;
    }

    @Override
    public int getCloColor() {//color for clo
        return 0xff666600;
    }

    @Override
    public int getVarColor() {//color for var
        return 0xff660066;
    }

    @Override
    public int getFunColor() {//color for fun
        return Color.RED;
    }

    @Override
    public int getNocodeColor() {color for nocode
        return 0xff000000;
    }
}

License

Copyright 2016 yydcdut

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.