Giter VIP home page Giter VIP logo

markdown-it-android's Introduction

markdown-it-android

License JitPack

Markdown View for Android, based on markdown-it and WebView.

Preview

Features

Usage

Setup

Add it in your root build.gradle at the end of repositories(for older gradle version):

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

Or add following to settings.gradle(for newer gradle version):

dependencyResolutionManagement {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

Add the dependency:

dependencies {
	implementation 'com.github.imcloudfloating:markdown-it-android:1.0.4'
}

Use in project

Required SDK Version >= 22.

Data Binding:

<com.github.imcloudfloating.markdown.MarkdownIt
    android:id="@+id/markdown_view"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:markdownString="@{viewModel.content}" />

No Data Binding:

val md = "# Hello, Markdown!"

findViewById<MarkdownIt>(R.id.markdown_view).markdownString = md

If the HTTP image link cannot be displayed, add android:usesCleartextTraffic="true" to AndroidManifest.xml of your project.

Fields and methods

Field/Method Note
fitSystemTheme Default is true, auto fit system theme.
darkTheme Use dark theme when fitSystemTheme = false
markdownString The markdown content you want to show.
urlClickListener Click listener for link.

markdown-it-android's People

Contributors

ifyun avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.