133 lines
33 KiB
HTML
133 lines
33 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en-US">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>Editor | Markwon</title>
|
|
<meta name="description" content="Android markdown library based on commonmark specification that renders markdown as system-native Spannables (no WebView)">
|
|
<link rel="apple-touch-icon" sizes="180x180" href="/Markwon/apple-touch-icon.png?v=1">
|
|
<link rel="icon" type="image/png" sizes="16x16" href="/Markwon/favicon-16x16.png?v=1">
|
|
<link rel="icon" href="/Markwon/favicon.ico?v=1">
|
|
<link rel="icon" type="image/png" sizes="32x32" href="/Markwon/favicon-32x32.png?v=1">
|
|
<link rel="manifest" href="/Markwon/manifest.json?v=1">
|
|
<meta name="keywords" content="android,markdown,library,spannable,markwon,commonmark">
|
|
|
|
<link rel="preload" href="/Markwon/assets/css/0.styles.3fbbce9e.css" as="style"><link rel="preload" href="/Markwon/assets/js/app.bdfd2bc6.js" as="script"><link rel="preload" href="/Markwon/assets/js/66.4a29728a.js" as="script"><link rel="preload" href="/Markwon/assets/js/3.eaac0903.js" as="script"><link rel="preload" href="/Markwon/assets/js/16.076204be.js" as="script"><link rel="prefetch" href="/Markwon/assets/js/42.d7ca0851.js"><link rel="prefetch" href="/Markwon/assets/js/2.81714ae9.js"><link rel="prefetch" href="/Markwon/assets/js/4.31fa5321.js"><link rel="prefetch" href="/Markwon/assets/js/5.6234b6a3.js"><link rel="prefetch" href="/Markwon/assets/js/6.ef59e46d.js"><link rel="prefetch" href="/Markwon/assets/js/7.e9b37c71.js"><link rel="prefetch" href="/Markwon/assets/js/8.9dff76ac.js"><link rel="prefetch" href="/Markwon/assets/js/9.7d018a47.js"><link rel="prefetch" href="/Markwon/assets/js/10.99fc608c.js"><link rel="prefetch" href="/Markwon/assets/js/11.cdc173e9.js"><link rel="prefetch" href="/Markwon/assets/js/12.98308542.js"><link rel="prefetch" href="/Markwon/assets/js/13.83b81b01.js"><link rel="prefetch" href="/Markwon/assets/js/14.0e5fe31e.js"><link rel="prefetch" href="/Markwon/assets/js/15.724f3dc4.js"><link rel="prefetch" href="/Markwon/assets/js/17.9412daf3.js"><link rel="prefetch" href="/Markwon/assets/js/18.187f0167.js"><link rel="prefetch" href="/Markwon/assets/js/19.af3507a7.js"><link rel="prefetch" href="/Markwon/assets/js/20.dc11e22f.js"><link rel="prefetch" href="/Markwon/assets/js/21.393a507f.js"><link rel="prefetch" href="/Markwon/assets/js/22.a6ac92c5.js"><link rel="prefetch" href="/Markwon/assets/js/23.9edcc0b3.js"><link rel="prefetch" href="/Markwon/assets/js/24.073942b3.js"><link rel="prefetch" href="/Markwon/assets/js/25.507307eb.js"><link rel="prefetch" href="/Markwon/assets/js/26.87c7e366.js"><link rel="prefetch" href="/Markwon/assets/js/27.a6f7a96f.js"><link rel="prefetch" href="/Markwon/assets/js/28.c0caacb4.js"><link rel="prefetch" href="/Markwon/assets/js/29.230c7321.js"><link rel="prefetch" href="/Markwon/assets/js/30.45e92827.js"><link rel="prefetch" href="/Markwon/assets/js/31.3a2ff699.js"><link rel="prefetch" href="/Markwon/assets/js/32.662e2ab9.js"><link rel="prefetch" href="/Markwon/assets/js/33.d83b2cb7.js"><link rel="prefetch" href="/Markwon/assets/js/34.4b19ef85.js"><link rel="prefetch" href="/Markwon/assets/js/35.1684da38.js"><link rel="prefetch" href="/Markwon/assets/js/36.9852715d.js"><link rel="prefetch" href="/Markwon/assets/js/37.e98b3352.js"><link rel="prefetch" href="/Markwon/assets/js/38.09771599.js"><link rel="prefetch" href="/Markwon/assets/js/39.37003a65.js"><link rel="prefetch" href="/Markwon/assets/js/40.bf595a01.js"><link rel="prefetch" href="/Markwon/assets/js/41.db50f781.js"><link rel="prefetch" href="/Markwon/assets/js/43.78500964.js"><link rel="prefetch" href="/Markwon/assets/js/44.60fec7f9.js"><link rel="prefetch" href="/Markwon/assets/js/45.78224b99.js"><link rel="prefetch" href="/Markwon/assets/js/46.9a7f306b.js"><link rel="prefetch" href="/Markwon/assets/js/47.42b56911.js"><link rel="prefetch" href="/Markwon/assets/js/48.cceb75d4.js"><link rel="prefetch" href="/Markwon/assets/js/49.20507df8.js"><link rel="prefetch" href="/Markwon/assets/js/50.f89d88b1.js"><link rel="prefetch" href="/Markwon/assets/js/51.d7ac54ce.js"><link rel="prefetch" href="/Markwon/assets/js/52.394ded4e.js"><link rel="prefetch" href="/Markwon/assets/js/53.144cf408.js"><link rel="prefetch" href="/Markwon/assets/js/54.0f936c4f.js"><link rel="prefetch" href="/Markwon/assets/js/55.5b7382a9.js"><link rel="prefetch" href="/Markwon/assets/js/56.1cf2f788.js"><link rel="prefetch" href="/Markwon/assets/js/57.1b7dddc1.js"><link rel="prefetch" href="/Markwon/assets/js/58.5271aaaf.js"><link rel="prefetch" href="/Markwon/assets/js/59.7ef6ac9a.js"><link rel="prefetch" href="/Markwon/assets/js/60.9bbfa80f.js"><link rel="prefetch" href="/Markwon/assets/js/61.628c1500.js"><link rel="prefetch" href="/Markwon/assets/js/62.d4d206d7.js"><link rel="prefetch" href="/Markwon/assets/js/63.8ccf8bfc.js"><link rel="prefetch" href="/Markwon/assets/js/64.7672a52b.js"><link rel="prefetch" href="/Markwon/assets/js/65.c4f000dc.js"><link rel="prefetch" href="/Markwon/assets/js/67.7331c7c7.js"><link rel="prefetch" href="/Markwon/assets/js/68.9d1d2ae1.js"><link rel="prefetch" href="/Markwon/assets/js/69.fd31295a.js"><link rel="prefetch" href="/Markwon/assets/js/70.fac8f892.js"><link rel="prefetch" href="/Markwon/assets/js/71.c3fcfb65.js"><link rel="prefetch" href="/Markwon/assets/js/72.d2389fc9.js"><link rel="prefetch" href="/Markwon/assets/js/73.6ce21170.js"><link rel="prefetch" href="/Markwon/assets/js/74.2ad91074.js"><link rel="prefetch" href="/Markwon/assets/js/75.1d59d27c.js"><link rel="prefetch" href="/Markwon/assets/js/76.f3844391.js"><link rel="prefetch" href="/Markwon/assets/js/77.4e5a82c3.js"><link rel="prefetch" href="/Markwon/assets/js/78.ff7203ee.js"><link rel="prefetch" href="/Markwon/assets/js/79.b1718a0d.js"><link rel="prefetch" href="/Markwon/assets/js/80.802db0eb.js"><link rel="prefetch" href="/Markwon/assets/js/81.9edd3cd9.js"><link rel="prefetch" href="/Markwon/assets/js/82.52f04a34.js"><link rel="prefetch" href="/Markwon/assets/js/83.3bd397c0.js"><link rel="prefetch" href="/Markwon/assets/js/84.a9af8a34.js"><link rel="prefetch" href="/Markwon/assets/js/85.2a0d8d40.js">
|
|
<link rel="stylesheet" href="/Markwon/assets/css/0.styles.3fbbce9e.css">
|
|
</head>
|
|
<body>
|
|
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/Markwon/" class="home-link router-link-active"><!----> <span class="site-name">Markwon</span></a> <div class="links" style="max-width:nullpx;"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/Markwon/docs/v4/install.html" class="nav-link">Install</a></div><div class="nav-item"><div class="dropdown-wrapper"><a class="dropdown-title"><span class="title">API Version</span> <span class="arrow right"></span></a> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><h4>Latest</h4> <ul class="dropdown-subitem-wrapper"><li class="dropdown-subitem"><a href="/Markwon/" class="nav-link">4.x.x</a></li></ul></li><li class="dropdown-item"><h4>Legacy</h4> <ul class="dropdown-subitem-wrapper"><li class="dropdown-subitem"><a href="/Markwon/docs/v3/install.html" class="nav-link">3.x.x</a></li><li class="dropdown-subitem"><a href="/Markwon/docs/v2/" class="nav-link">2.x.x</a></li></ul></li></ul></div></div><div class="nav-item"><a href="https://github.com/noties/Markwon/blob/master/CHANGELOG.md" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
Changelog
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div><div class="nav-item"><a href="https://github.com/noties/Markwon" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
Github
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <div class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/Markwon/docs/v4/install.html" class="nav-link">Install</a></div><div class="nav-item"><div class="dropdown-wrapper"><a class="dropdown-title"><span class="title">API Version</span> <span class="arrow right"></span></a> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><h4>Latest</h4> <ul class="dropdown-subitem-wrapper"><li class="dropdown-subitem"><a href="/Markwon/" class="nav-link">4.x.x</a></li></ul></li><li class="dropdown-item"><h4>Legacy</h4> <ul class="dropdown-subitem-wrapper"><li class="dropdown-subitem"><a href="/Markwon/docs/v3/install.html" class="nav-link">3.x.x</a></li><li class="dropdown-subitem"><a href="/Markwon/docs/v2/" class="nav-link">2.x.x</a></li></ul></li></ul></div></div><div class="nav-item"><a href="https://github.com/noties/Markwon/blob/master/CHANGELOG.md" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
Changelog
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div><div class="nav-item"><a href="https://github.com/noties/Markwon" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
Github
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav> <ul class="sidebar-links"><li><a href="/Markwon/" class="sidebar-link">Introduction</a></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Core</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/Markwon/docs/v4/core/getting-started.html" class="sidebar-link">Getting started</a></li><li><a href="/Markwon/docs/v4/core/plugins.html" class="sidebar-link">Plugins</a></li><li><a href="/Markwon/docs/v4/core/registry.html" class="sidebar-link">Registry</a></li><li><a href="/Markwon/docs/v4/core/theme.html" class="sidebar-link">Theme</a></li><li><a href="/Markwon/docs/v4/core/configuration.html" class="sidebar-link">Configuration</a></li><li><a href="/Markwon/docs/v4/core/visitor.html" class="sidebar-link">Visitor</a></li><li><a href="/Markwon/docs/v4/core/spans-factory.html" class="sidebar-link">Spans Factory</a></li><li><a href="/Markwon/docs/v4/core/core-plugin.html" class="sidebar-link">Core plugin</a></li><li><a href="/Markwon/docs/v4/core/movement-method-plugin.html" class="sidebar-link">Movement method plugin</a></li><li><a href="/Markwon/docs/v4/core/render-props.html" class="sidebar-link">RenderProps</a></li><li><a href="/Markwon/docs/v4/core/text-setter.html" class="sidebar-link">TextSetter</a></li></ul></div></li><li><a href="/Markwon/docs/v4/editor/" class="active sidebar-link">Editor</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/Markwon/docs/v4/editor/#getting-started-with-editor" class="sidebar-link">Getting started with editor</a></li><li class="sidebar-sub-header"><a href="/Markwon/docs/v4/editor/#custom-punctuation-span" class="sidebar-link">Custom punctuation span</a></li><li class="sidebar-sub-header"><a href="/Markwon/docs/v4/editor/#additional-handling" class="sidebar-link">Additional handling</a></li></ul></li><li><a href="/Markwon/docs/v4/ext-latex/" class="sidebar-link">LaTeX extension</a></li><li><a href="/Markwon/docs/v4/ext-strikethrough/" class="sidebar-link">Strikethrough extension</a></li><li><a href="/Markwon/docs/v4/ext-tables/" class="sidebar-link">Tables extension</a></li><li><a href="/Markwon/docs/v4/ext-tasklist/" class="sidebar-link">Task list extension</a></li><li><a href="/Markwon/docs/v4/html/" class="sidebar-link">HTML</a></li><li><a href="/Markwon/docs/v4/image/" class="sidebar-link">Image</a></li><li><a href="/Markwon/docs/v4/image-coil/" class="sidebar-link">Image Coil</a></li><li><a href="/Markwon/docs/v4/image-glide/" class="sidebar-link">Image Glide</a></li><li><a href="/Markwon/docs/v4/image-picasso/" class="sidebar-link">Image Picasso</a></li><li><a href="/Markwon/docs/v4/inline-parser/" class="sidebar-link">Inline Parser</a></li><li><a href="/Markwon/docs/v4/linkify/" class="sidebar-link">Linkify</a></li><li><a href="/Markwon/docs/v4/recycler/" class="sidebar-link">Recycler</a></li><li><a href="/Markwon/docs/v4/recycler-table/" class="sidebar-link">Recycler Table</a></li><li><a href="/Markwon/docs/v4/simple-ext/" class="sidebar-link">Simple Extension</a></li><li><a href="/Markwon/docs/v4/syntax-highlight/" class="sidebar-link">Syntax highlight</a></li><li><a href="/Markwon/docs/v4/recipes.html" class="sidebar-link">Recipes</a></li></ul> </div> <div class="page"> <div class="content"><h1 id="editor"><a href="#editor" aria-hidden="true" class="header-anchor">#</a> Editor <span class="badge tip top" data-v-099ab69c>4.2.0</span></h1> <a href="http://search.maven.org/#search|ga|1|g%3A%22io.noties.markwon%22%20AND%20a%3A%22editor%22"><img src="https://img.shields.io/maven-central/v/io.noties.markwon/editor.svg?label=editor" alt="editor"></a> <p>Markdown editing highlight for Android based on <strong>Markwon</strong>.</p> <video controls="controls" loop="loop" poster="/Markwon/assets/markwon-editor-preview.jpg"><source src="/Markwon/assets/markwon-editor.mp4" type="video/mp4">
|
|
You browser does not support mp4 playback, try downloading video file
|
|
<a href="/Markwon/assets/markwon-editor.mp4">directly</a></video> <h2 id="getting-started-with-editor"><a href="#getting-started-with-editor" aria-hidden="true" class="header-anchor">#</a> Getting started with editor</h2> <div class="language-java extra-class"><pre class="language-java"><code><span class="token comment">// obtain Markwon instance</span>
|
|
<span class="token keyword">final</span> Markwon markwon <span class="token operator">=</span> Markwon<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token keyword">this</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
|
|
<span class="token comment">// create editor</span>
|
|
<span class="token keyword">final</span> MarkwonEditor editor <span class="token operator">=</span> MarkwonEditor<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span>markwon<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
|
|
<span class="token comment">// set edit listener</span>
|
|
editText<span class="token punctuation">.</span><span class="token function">addTextChangedListener</span><span class="token punctuation">(</span>MarkwonEditorTextWatcher<span class="token punctuation">.</span><span class="token function">withProcess</span><span class="token punctuation">(</span>editor<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
</code></pre></div><p>The code above <em>highlights</em> in-place which is OK for relatively small markdown inputs.
|
|
If you wish to offload main thread and highlight in background use <code>withPreRender</code> <code>MarkwonEditorTextWatcher</code>:</p> <div class="language-java extra-class"><pre class="language-java"><code>editText<span class="token punctuation">.</span><span class="token function">addTextChangedListener</span><span class="token punctuation">(</span>MarkwonEditorTextWatcher<span class="token punctuation">.</span><span class="token function">withPreRender</span><span class="token punctuation">(</span>
|
|
editor<span class="token punctuation">,</span>
|
|
Executors<span class="token punctuation">.</span><span class="token function">newCachedThreadPool</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
|
|
editText<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
</code></pre></div><p><code>MarkwonEditorTextWatcher</code> automatically triggers markdown highlight when text in <code>EditText</code> changes.
|
|
But you still can invoke <code>MarkwonEditor</code> manually:</p> <div class="language-java extra-class"><pre class="language-java"><code>editor<span class="token punctuation">.</span><span class="token function">process</span><span class="token punctuation">(</span>editText<span class="token punctuation">.</span><span class="token function">getText</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
|
|
<span class="token comment">// please note that MarkwonEditor operates on caller thread,</span>
|
|
<span class="token comment">// if you wish to execute this operation in background - this method</span>
|
|
<span class="token comment">// must be called from background thread</span>
|
|
editor<span class="token punctuation">.</span><span class="token function">preRender</span><span class="token punctuation">(</span>editText<span class="token punctuation">.</span><span class="token function">getText</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> <span class="token keyword">new</span> <span class="token class-name">MarkwonEditor<span class="token punctuation">.</span>PreRenderResultListener</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token annotation punctuation">@Override</span>
|
|
<span class="token keyword">public</span> <span class="token keyword">void</span> <span class="token function">onPreRenderResult</span><span class="token punctuation">(</span><span class="token annotation punctuation">@NonNull</span> MarkwonEditor<span class="token punctuation">.</span>PreRenderResult result<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token comment">// it's wise to check if rendered result is for the same input,</span>
|
|
<span class="token comment">// for example by matching raw input</span>
|
|
<span class="token keyword">if</span> <span class="token punctuation">(</span>editText<span class="token punctuation">.</span><span class="token function">getText</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">equals</span><span class="token punctuation">(</span>result<span class="token punctuation">.</span><span class="token function">resultEditable</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
|
|
<span class="token comment">// if you are in background thread do not forget</span>
|
|
<span class="token comment">// to execute dispatch in main thread</span>
|
|
result<span class="token punctuation">.</span><span class="token function">dispatchTo</span><span class="token punctuation">(</span>editText<span class="token punctuation">.</span><span class="token function">getText</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
</code></pre></div><div class="warning custom-block"><p class="custom-block-title">Implementation Detail</p> <p>It must be mentioned that highlight is implemented via text diff. Everything
|
|
that is present in raw markdown input but missing from rendered result is considered
|
|
to be <em>punctuation</em>.</p></div> <div class="danger custom-block"><p class="custom-block-title">Tables and LaTeX</p> <p>Tables and LaTeX nodes won't be rendered correctly. They will be treated as <em>punctuation</em>
|
|
as whole. This comes from their implementation - they are <em>mocked</em> and do not present
|
|
in final result as text and thus cannot be <em>diffed</em>.</p></div> <h2 id="custom-punctuation-span"><a href="#custom-punctuation-span" aria-hidden="true" class="header-anchor">#</a> Custom punctuation span</h2> <p>By default <code>MarkwonEditor</code> uses lighter text color of widget to customize punctuation.
|
|
If you wish to use a different span you can use <code>punctuationSpan</code> configuration step:</p> <div class="language-java extra-class"><pre class="language-java"><code><span class="token keyword">final</span> MarkwonEditor editor <span class="token operator">=</span> MarkwonEditor<span class="token punctuation">.</span><span class="token function">builder</span><span class="token punctuation">(</span>Markwon<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token keyword">this</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">punctuationSpan</span><span class="token punctuation">(</span>CustomPunctuationSpan<span class="token punctuation">.</span><span class="token keyword">class</span><span class="token punctuation">,</span> CustomPunctuationSpan<span class="token operator">:</span><span class="token operator">:</span><span class="token keyword">new</span><span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
</code></pre></div><div class="language-java extra-class"><pre class="language-java"><code><span class="token keyword">public</span> <span class="token keyword">class</span> <span class="token class-name">CustomPunctuationSpan</span> <span class="token keyword">extends</span> <span class="token class-name">ForegroundColorSpan</span> <span class="token punctuation">{</span>
|
|
<span class="token function">CustomPunctuationSpan</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token keyword">super</span><span class="token punctuation">(</span><span class="token number">0xFFFF0000</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// RED</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span>
|
|
</code></pre></div><h2 id="additional-handling"><a href="#additional-handling" aria-hidden="true" class="header-anchor">#</a> Additional handling</h2> <p>In order to additionally highlight portions of markdown input (for example make text wrapped with <code>**</code>
|
|
symbols <strong>bold</strong>) <code>EditHandler</code> can be used:</p> <div class="language-java extra-class"><pre class="language-java"><code><span class="token keyword">final</span> MarkwonEditor editor <span class="token operator">=</span> MarkwonEditor<span class="token punctuation">.</span><span class="token function">builder</span><span class="token punctuation">(</span>Markwon<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token keyword">this</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">useEditHandler</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">AbstractEditHandler</span><span class="token generics function"><span class="token punctuation"><</span>StrongEmphasisSpan<span class="token punctuation">></span></span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token annotation punctuation">@Override</span>
|
|
<span class="token keyword">public</span> <span class="token keyword">void</span> <span class="token function">configurePersistedSpans</span><span class="token punctuation">(</span><span class="token annotation punctuation">@NonNull</span> PersistedSpans<span class="token punctuation">.</span>Builder builder<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token comment">// Here we define which span is _persisted_ in EditText, it is not removed</span>
|
|
<span class="token comment">// from EditText between text changes, but instead - reused (by changing</span>
|
|
<span class="token comment">// position). Consider it as a cache for spans. We could use `StrongEmphasisSpan`</span>
|
|
<span class="token comment">// here also, but I chose Bold to indicate that this span is not the same</span>
|
|
<span class="token comment">// as in off-screen rendered markdown</span>
|
|
builder<span class="token punctuation">.</span><span class="token function">persistSpan</span><span class="token punctuation">(</span>Bold<span class="token punctuation">.</span><span class="token keyword">class</span><span class="token punctuation">,</span> Bold<span class="token operator">:</span><span class="token operator">:</span><span class="token keyword">new</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span>
|
|
|
|
<span class="token annotation punctuation">@Override</span>
|
|
<span class="token keyword">public</span> <span class="token keyword">void</span> <span class="token function">handleMarkdownSpan</span><span class="token punctuation">(</span>
|
|
<span class="token annotation punctuation">@NonNull</span> PersistedSpans persistedSpans<span class="token punctuation">,</span>
|
|
<span class="token annotation punctuation">@NonNull</span> Editable editable<span class="token punctuation">,</span>
|
|
<span class="token annotation punctuation">@NonNull</span> String input<span class="token punctuation">,</span>
|
|
<span class="token annotation punctuation">@NonNull</span> StrongEmphasisSpan span<span class="token punctuation">,</span>
|
|
<span class="token keyword">int</span> spanStart<span class="token punctuation">,</span>
|
|
<span class="token keyword">int</span> spanTextLength<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token comment">// Unfortunately we cannot hardcode delimiters length here (aka spanTextLength + 4)</span>
|
|
<span class="token comment">// because multiple inline markdown nodes can refer to the same text.</span>
|
|
<span class="token comment">// For example, `**_~~hey~~_**` - we will receive `**_~~` in this method,</span>
|
|
<span class="token comment">// and thus will have to manually find actual position in raw user input</span>
|
|
<span class="token keyword">final</span> MarkwonEditorUtils<span class="token punctuation">.</span>Match match <span class="token operator">=</span>
|
|
MarkwonEditorUtils<span class="token punctuation">.</span><span class="token function">findDelimited</span><span class="token punctuation">(</span>input<span class="token punctuation">,</span> spanStart<span class="token punctuation">,</span> <span class="token string">"**"</span><span class="token punctuation">,</span> <span class="token string">"__"</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token keyword">if</span> <span class="token punctuation">(</span>match <span class="token operator">!=</span> null<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
editable<span class="token punctuation">.</span><span class="token function">setSpan</span><span class="token punctuation">(</span>
|
|
<span class="token comment">// we handle StrongEmphasisSpan and represent it with Bold in EditText</span>
|
|
<span class="token comment">// we still could use StrongEmphasisSpan, but it must be accessed</span>
|
|
<span class="token comment">// via persistedSpans</span>
|
|
persistedSpans<span class="token punctuation">.</span><span class="token function">get</span><span class="token punctuation">(</span>Bold<span class="token punctuation">.</span><span class="token keyword">class</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
|
|
match<span class="token punctuation">.</span><span class="token function">start</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
|
|
match<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
|
|
Spanned<span class="token punctuation">.</span>SPAN_EXCLUSIVE_EXCLUSIVE
|
|
<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span>
|
|
|
|
<span class="token annotation punctuation">@NonNull</span>
|
|
<span class="token annotation punctuation">@Override</span>
|
|
<span class="token keyword">public</span> Class<span class="token generics function"><span class="token punctuation"><</span>StrongEmphasisSpan<span class="token punctuation">></span></span> <span class="token function">markdownSpanType</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token keyword">return</span> StrongEmphasisSpan<span class="token punctuation">.</span><span class="token keyword">class</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span><span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
</code></pre></div></div> <div class="page-edit"><!----> <div class="last-updated"><span class="prefix">Last Updated: </span> <span class="time">11/11/2019, 5:15:18 PM</span></div></div> <div class="page-nav"><p class="inner"><span class="prev">
|
|
←
|
|
<a href="/Markwon/docs/v4/core/text-setter.html" class="prev">
|
|
TextSetter
|
|
</a></span> <span class="next"><a href="/Markwon/docs/v4/ext-latex/">
|
|
LaTeX extension
|
|
</a>
|
|
→
|
|
</span></p></div> </div> <!----></div></div>
|
|
<script src="/Markwon/assets/js/66.4a29728a.js" defer></script><script src="/Markwon/assets/js/3.eaac0903.js" defer></script><script src="/Markwon/assets/js/16.076204be.js" defer></script><script src="/Markwon/assets/js/app.bdfd2bc6.js" defer></script>
|
|
</body>
|
|
</html>
|