1 line
12 KiB
JavaScript
1 line
12 KiB
JavaScript
(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{282:function(t,s,a){"use strict";a.r(s);var n=a(0),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("div",{staticClass:"content"},[t._m(0),t._v(" "),a("LegacyWarning"),t._v(" "),a("MavenBadges2xx"),t._v(" "),t._m(1),t._v(" "),t._m(2),a("p",[t._v("This is core artifact that is sufficient to start displaying markdown in your Android applications.")]),t._v(" "),t._m(3),t._v(" "),t._m(4),t._m(5),t._v(" "),t._m(6),t._v(" "),t._m(7),t._m(8),t._v(" "),t._m(9),t._v(" "),a("p",[t._v("Please refer to documentation for "),a("router-link",{attrs:{to:"/docs/v2/image-loader.html"}},[t._v("image loader")]),t._v(" module")],1),t._v(" "),t._m(10),t._v(" "),t._m(11),a("p",[t._v("Provides implementation of "),a("code",[t._v("SyntaxHighlight")]),t._v(" and allows various syntax highlighting\nin your markdown based Android applications. Comes with 2 ready-to-be-used themes: "),a("code",[t._v("light")]),t._v(" and "),a("code",[t._v("dark")]),t._v(".\nPlease refer to documentation for "),a("router-link",{attrs:{to:"/docs/v2/syntax-highlight.html"}},[t._v("syntax highlight")]),t._v(" module")],1),t._v(" "),t._m(12),t._v(" "),t._m(13),a("p",[t._v("Provides 2 widgets to display markdown: "),a("code",[t._v("MarkwonView")]),t._v(" and "),a("code",[t._v("MarkwonViewCompat")]),t._v(" (subclasses\nof "),a("code",[t._v("TextView")]),t._v(" and "),a("code",[t._v("AppCompatTextView")]),t._v(" respectively).\nPlease refer to documentation for "),a("router-link",{attrs:{to:"/docs/v2/view.html"}},[t._v("view")]),t._v(" module")],1),t._v(" "),t._m(14),t._v(" "),t._m(15),t._v(" "),t._m(16),t._m(17),t._v(" "),t._m(18),t._v(" "),t._m(19),t._v(" "),t._m(20),t._v(" "),t._m(21),t._v(" "),t._m(22),t._m(23),t._v(" "),t._m(24),t._m(25)],1)},[function(){var t=this.$createElement,s=this._self._c||t;return s("h1",{attrs:{id:"installation"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#installation","aria-hidden":"true"}},[this._v("#")]),this._v(" Installation")])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("In order to start using "),s("code",[this._v("Markwon")]),this._v(" add this to your dependencies block\nin your projects "),s("code",[this._v("build.gradle")]),this._v(":")])},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("div",{staticClass:"language-groovy extra-class"},[a("pre",{pre:!0,attrs:{class:"language-groovy"}},[a("code",[t._v("implementation "),a("span",{attrs:{class:"token string gstring"}},[t._v('"ru.noties:markwon:'),a("span",{attrs:{class:"token expression"}},[a("span",{attrs:{class:"token punctuation"}},[t._v("$")]),a("span",{attrs:{class:"token punctuation"}},[t._v("{")]),t._v("markwonVersion"),a("span",{attrs:{class:"token punctuation"}},[t._v("}")])]),t._v('"')]),t._v("\n")])])])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[s("code",[this._v("Markwon")]),this._v(" comes with more artifacts that cover additional functionality, but they are\n"),s("strong",[this._v("not")]),this._v(" required to be used, as most of them provide implementations for functionality\nthat is "),s("em",[this._v("interfaced")]),this._v(" in the core artifact")])},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("div",{staticClass:"language-groovy extra-class"},[a("pre",{pre:!0,attrs:{class:"language-groovy"}},[a("code",[t._v("implementation "),a("span",{attrs:{class:"token string gstring"}},[t._v('"ru.noties:markwon-image-loader:'),a("span",{attrs:{class:"token expression"}},[a("span",{attrs:{class:"token punctuation"}},[t._v("$")]),a("span",{attrs:{class:"token punctuation"}},[t._v("{")]),t._v("markwonVersion"),a("span",{attrs:{class:"token punctuation"}},[t._v("}")])]),t._v('"')]),t._v("\nimplementation "),a("span",{attrs:{class:"token string gstring"}},[t._v('"ru.noties:markwon-syntax-highlight:'),a("span",{attrs:{class:"token expression"}},[a("span",{attrs:{class:"token punctuation"}},[t._v("$")]),a("span",{attrs:{class:"token punctuation"}},[t._v("{")]),t._v("markwonVersion"),a("span",{attrs:{class:"token punctuation"}},[t._v("}")])]),t._v('"')]),t._v("\nimplementation "),a("span",{attrs:{class:"token string gstring"}},[t._v('"ru.noties:markwon-view:'),a("span",{attrs:{class:"token expression"}},[a("span",{attrs:{class:"token punctuation"}},[t._v("$")]),a("span",{attrs:{class:"token punctuation"}},[t._v("{")]),t._v("markwonVersion"),a("span",{attrs:{class:"token punctuation"}},[t._v("}")])]),t._v('"')]),t._v("\n")])])])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("These artifacts share the same "),s("em",[this._v("version")]),this._v(" as the core artifact")])},function(){var t=this.$createElement,s=this._self._c||t;return s("h3",{attrs:{id:"image-loader"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#image-loader","aria-hidden":"true"}},[this._v("#")]),this._v(" Image loader")])},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("div",{staticClass:"language-groovy extra-class"},[a("pre",{pre:!0,attrs:{class:"language-groovy"}},[a("code",[t._v("implementation "),a("span",{attrs:{class:"token string gstring"}},[t._v('"ru.noties:markwon-image-loader:'),a("span",{attrs:{class:"token expression"}},[a("span",{attrs:{class:"token punctuation"}},[t._v("$")]),a("span",{attrs:{class:"token punctuation"}},[t._v("{")]),t._v("markwonVersion"),a("span",{attrs:{class:"token punctuation"}},[t._v("}")])]),t._v('"')]),t._v("\n")])])])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("Provides implementation of "),s("code",[this._v("AsyncDrawable.Loader")]),this._v(" and comes with support for:")])},function(){var t=this.$createElement,s=this._self._c||t;return s("ul",[s("li",[this._v("SVG")]),this._v(" "),s("li",[this._v("GIF")]),this._v(" "),s("li",[this._v("Other image formats")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("h3",{attrs:{id:"syntax-highlight"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#syntax-highlight","aria-hidden":"true"}},[this._v("#")]),this._v(" Syntax highlight")])},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("div",{staticClass:"language-groovy extra-class"},[a("pre",{pre:!0,attrs:{class:"language-groovy"}},[a("code",[t._v("implementation "),a("span",{attrs:{class:"token string gstring"}},[t._v('"ru.noties:markwon-syntax-highlight:'),a("span",{attrs:{class:"token expression"}},[a("span",{attrs:{class:"token punctuation"}},[t._v("$")]),a("span",{attrs:{class:"token punctuation"}},[t._v("{")]),t._v("markwonVersion"),a("span",{attrs:{class:"token punctuation"}},[t._v("}")])]),t._v('"')]),t._v("\n")])])])},function(){var t=this.$createElement,s=this._self._c||t;return s("h3",{attrs:{id:"view"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#view","aria-hidden":"true"}},[this._v("#")]),this._v(" View")])},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("div",{staticClass:"language-groovy extra-class"},[a("pre",{pre:!0,attrs:{class:"language-groovy"}},[a("code",[t._v("implementation "),a("span",{attrs:{class:"token string gstring"}},[t._v('"ru.noties:markwon-view:'),a("span",{attrs:{class:"token expression"}},[a("span",{attrs:{class:"token punctuation"}},[t._v("$")]),a("span",{attrs:{class:"token punctuation"}},[t._v("{")]),t._v("markwonVersion"),a("span",{attrs:{class:"token punctuation"}},[t._v("}")])]),t._v('"')]),t._v("\n")])])])},function(){var t=this.$createElement,s=this._self._c||t;return s("h2",{attrs:{id:"proguard"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#proguard","aria-hidden":"true"}},[this._v("#")]),this._v(" Proguard")])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("When using "),s("code",[this._v("markwon-image-loader")]),this._v(" artifact and Proguard is enabled, add these rules\nto your proguard configuration:")])},function(){var t=this.$createElement,s=this._self._c||t;return s("div",{staticClass:"language-proguard extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[this._v("-dontwarn okhttp3.**\n-dontwarn okio.**\n\n-keep class com.caverock.androidsvg.** { *; }\n-dontwarn com.caverock.androidsvg.**\n")])])])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("They come from dependencies that "),s("code",[this._v("markwon-image-loader")]),this._v(" is using.")])},function(){var t=this.$createElement,s=this._self._c||t;return s("div",{staticClass:"tip custom-block"},[s("p",{staticClass:"custom-block-title"},[this._v("Other artifacts")]),this._v(" "),s("p",[this._v("Other artifacts do not require special Proguard rules")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("h2",{attrs:{id:"snapshot"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#snapshot","aria-hidden":"true"}},[this._v("#")]),this._v(" Snapshot")])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[s("img",{attrs:{src:"https://img.shields.io/nexus/s/https/oss.sonatype.org/ru.noties/markwon.svg?label=markwon",alt:"markwon-snapshot"}})])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("In order to use latest "),s("code",[this._v("SNAPSHOT")]),this._v(" version add snapshot repository\nto your root project's "),s("code",[this._v("build.gradle")]),this._v(" file:")])},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("div",{staticClass:"language-groovy extra-class"},[a("pre",{pre:!0,attrs:{class:"language-groovy"}},[a("code",[t._v("allprojects "),a("span",{attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n repositories "),a("span",{attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{attrs:{class:"token function"}},[t._v("jcenter")]),a("span",{attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{attrs:{class:"token function"}},[t._v("google")]),a("span",{attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n maven "),a("span",{attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" url "),a("span",{attrs:{class:"token string"}},[t._v("'https://oss.sonatype.org/content/repositories/snapshots/'")]),t._v(" "),a("span",{attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("and then in your module "),s("code",[this._v("build.gradle")]),this._v(":")])},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("div",{staticClass:"language-groovy extra-class"},[a("pre",{pre:!0,attrs:{class:"language-groovy"}},[a("code",[t._v("implementation "),a("span",{attrs:{class:"token string gstring"}},[t._v('"ru.noties:markwon:'),a("span",{attrs:{class:"token expression"}},[a("span",{attrs:{class:"token punctuation"}},[t._v("$")]),a("span",{attrs:{class:"token punctuation"}},[t._v("{")]),t._v("markwonSnapshotVersion"),a("span",{attrs:{class:"token punctuation"}},[t._v("}")])]),t._v('"')]),t._v("\n")])])])},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("p",[t._v("Please note that "),a("code",[t._v("markwon-image-loader")]),t._v(", "),a("code",[t._v("markwon-syntax-highlight")]),t._v("\nand "),a("code",[t._v("markwon-view")]),t._v(" are also present in "),a("code",[t._v("SNAPSHOT")]),t._v(" repository and\nshare the same version as main "),a("code",[t._v("markwon")]),t._v(" artifact.")])}],!1,null,null,null);e.options.__file="install.md";s.default=e.exports}}]); |