26bfb7f2e2
* `SpannableMarkdownVisitor` Rename blockQuoteIndent to blockIndent * Fixed block new lines logic for block quote and paragraph (#82) * AsyncDrawable fix no dimensions bug (#81) * Update SpannableTheme to use Px instead of Dimension annotation * Allow TaskListSpan isDone mutation * Updated commonmark-java to 0.12.1 * Add OrderedListItemSpan measure utility method (#78) * Add SpannableBuilder#getSpans method * Fix DataUri scheme handler in image-loader (#74) * Introduced a "copy" builder for SpannableThem Thanks @c-b-h 🙌
314 lines
8.9 KiB
Markdown
314 lines
8.9 KiB
Markdown
|
|
|
|
# Markwon
|
|
|
|
[](http://search.maven.org/#search|ga|1|g%3A%22ru.noties%22%20AND%20a%3A%22markwon%22)
|
|
[](http://search.maven.org/#search|ga|1|g%3A%22ru.noties%22%20AND%20a%3A%22markwon-image-loader%22)
|
|
[](http://search.maven.org/#search|ga|1|g%3A%22ru.noties%22%20AND%20a%3A%22markwon-syntax-highlight%22)
|
|
[](http://search.maven.org/#search|ga|1|g%3A%22ru.noties%22%20AND%20a%3A%22markwon-view%22)
|
|
|
|
[](https://travis-ci.org/noties/Markwon)
|
|
|
|
**Markwon** is a markdown library for Android. It parses markdown
|
|
following [commonmark-spec] with the help of amazing [commonmark-java]
|
|
library and renders result as _Android-native_ Spannables. **No HTML**
|
|
is involved as an intermediate step. <u>**No WebView** is required</u>.
|
|
It's extremely fast, feature-rich and extensible.
|
|
|
|
It gives ability to display markdown in all TextView widgets
|
|
(**TextView**, **Button**, **Switch**, **CheckBox**, etc), **Toasts**
|
|
and all other places that accept **Spanned content**. Library provides
|
|
reasonable defaults to display style of a markdown content but also
|
|
gives all the means to tweak the appearance if desired. All markdown
|
|
features listed in [commonmark-spec] are supported
|
|
(including support for **inlined/block HTML code**, **markdown tables**,
|
|
**images** and **syntax highlight**).
|
|
|
|
[commonmark-spec]: https://spec.commonmark.org/0.28/
|
|
[commonmark-java]: https://github.com/atlassian/commonmark-java/blob/master/README.md
|
|
|
|
<sup>*</sup>*This file is displayed by default in the [sample-apk] (`markwon-sample-{latest-version}-debug.apk`) application. Which is a generic markdown viewer with support to display markdown via `http`, `https` & `file` schemes and 2 themes included: Light & Dark*
|
|
|
|
[sample-apk]: https://github.com/noties/Markwon/releases
|
|
|
|
## Installation
|
|
```groovy
|
|
implementation "ru.noties:markwon:${markwonVersion}"
|
|
implementation "ru.noties:markwon-image-loader:${markwonVersion}" // optional
|
|
implementation "ru.noties:markwon-syntax-highlight:${markwonVersion}" // optional
|
|
implementation "ru.noties:markwon-view:${markwonVersion}" // optional
|
|
```
|
|
|
|
Please visit [documentation] web-site for further reference
|
|
|
|
## Supported markdown features:
|
|
* Emphasis (`*`, `_`)
|
|
* Strong emphasis (`**`, `__`)
|
|
* Strike-through (`~~`)
|
|
* Headers (`#{1,6}`)
|
|
* Links (`[]()` && `[][]`)
|
|
* Images
|
|
* Thematic break (`---`, `***`, `___`)
|
|
* Quotes & nested quotes (`>{1,}`)
|
|
* Ordered & non-ordered lists & nested ones
|
|
* Inline code
|
|
* Code blocks
|
|
* Tables (*with limitations*)
|
|
* Syntax highlight
|
|
* HTML
|
|
* Emphasis (`<i>`, `<em>`, `<cite>`, `<dfn>`)
|
|
* Strong emphasis (`<b>`, `<strong>`)
|
|
* SuperScript (`<sup>`)
|
|
* SubScript (`<sub>`)
|
|
* Underline (`<u>`, `ins`)
|
|
* Strike-through (`<s>`, `<strike>`, `<del>`)
|
|
* Link (`a`)
|
|
* Lists (`ul`, `ol`)
|
|
* Images (`img` will require configured image loader)
|
|
* Blockquote (`blockquote`)
|
|
* Heading (`h1`, `h2`, `h3`, `h4`, `h5`, `h6`)
|
|
* there is support to render any HTML tag
|
|
* Task lists:
|
|
- [ ] Not _done_
|
|
- [X] **Done** with `X`
|
|
- [x] ~~and~~ **or** small `x`
|
|
---
|
|
|
|
## Screenshots
|
|
|
|
Taken with default configuration (except for image loading):
|
|
|
|
<a href="./art/mw_light_01.png"><img src="./art/mw_light_01.png" width="30%" /></a>
|
|
<a href="./art/mw_light_02.png"><img src="./art/mw_light_02.png" width="30%" /></a>
|
|
<a href="./art/mw_light_03.png"><img src="./art/mw_light_03.png" width="30%" /></a>
|
|
<a href="./art/mw_dark_01.png"><img src="./art/mw_dark_01.png" width="30%" /></a>
|
|
|
|
By default configuration uses TextView textColor for styling, so changing textColor changes style
|
|
|
|
---
|
|
|
|
## Documentation
|
|
|
|
Please visit [documentation] web-site for reference
|
|
|
|
[documentation]: https://noties.github.io/Markwon
|
|
|
|
---
|
|
|
|
## Applications using Markwon
|
|
|
|
* [Partiko](https://partiko.app)
|
|
* [FairNote Notepad](https://play.google.com/store/apps/details?id=com.rgiskard.fairnote)
|
|
|
|
|
|
---
|
|
|
|
# Demo
|
|
Based on [this cheatsheet][cheatsheet]
|
|
|
|
---
|
|
|
|
## Headers
|
|
---
|
|
# Header 1
|
|
## Header 2
|
|
### Header 3
|
|
#### Header 4
|
|
##### Header 5
|
|
###### Header 6
|
|
---
|
|
|
|
## Emphasis
|
|
|
|
Emphasis, aka italics, with *asterisks* or _underscores_.
|
|
|
|
Strong emphasis, aka bold, with **asterisks** or __underscores__.
|
|
|
|
Combined emphasis with **asterisks and _underscores_**.
|
|
|
|
Strikethrough uses two tildes. ~~Scratch this.~~
|
|
|
|
---
|
|
|
|
## Lists
|
|
1. First ordered list item
|
|
2. Another item
|
|
* Unordered sub-list.
|
|
1. Actual numbers don't matter, just that it's a number
|
|
1. Ordered sub-list
|
|
4. And another item.
|
|
|
|
You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
|
|
|
|
To have a line break without a paragraph, you will need to use two trailing spaces.
|
|
Note that this line is separate, but within the same paragraph.
|
|
(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
|
|
|
|
* Unordered list can use asterisks
|
|
- Or minuses
|
|
+ Or pluses
|
|
|
|
---
|
|
|
|
## Links
|
|
|
|
[I'm an inline-style link](https://www.google.com)
|
|
|
|
[I'm a reference-style link][Arbitrary case-insensitive reference text]
|
|
|
|
[I'm a relative reference to a repository file](../blob/master/LICENSE)
|
|
|
|
[You can use numbers for reference-style link definitions][1]
|
|
|
|
Or leave it empty and use the [link text itself].
|
|
|
|
---
|
|
|
|
## Code
|
|
|
|
Inline `code` has `back-ticks around` it.
|
|
|
|
```javascript
|
|
var s = "JavaScript syntax highlighting";
|
|
alert(s);
|
|
```
|
|
|
|
```python
|
|
s = "Python syntax highlighting"
|
|
print s
|
|
```
|
|
|
|
```java
|
|
/**
|
|
* Helper method to obtain a Parser with registered strike-through & table extensions
|
|
* & task lists (added in 1.0.1)
|
|
*
|
|
* @return a Parser instance that is supported by this library
|
|
* @since 1.0.0
|
|
*/
|
|
@NonNull
|
|
public static Parser createParser() {
|
|
return new Parser.Builder()
|
|
.extensions(Arrays.asList(
|
|
StrikethroughExtension.create(),
|
|
TablesExtension.create(),
|
|
TaskListExtension.create()
|
|
))
|
|
.build();
|
|
}
|
|
```
|
|
|
|
```xml
|
|
<ScrollView
|
|
android:id="@+id/scroll_view"
|
|
android:layout_width="match_parent"
|
|
android:layout_height="match_parent"
|
|
android:layout_marginTop="?android:attr/actionBarSize">
|
|
|
|
<TextView
|
|
android:id="@+id/text"
|
|
android:layout_width="match_parent"
|
|
android:layout_height="wrap_content"
|
|
android:layout_margin="16dip"
|
|
android:lineSpacingExtra="2dip"
|
|
android:textSize="16sp"
|
|
tools:context="ru.noties.markwon.MainActivity"
|
|
tools:text="yo\nman" />
|
|
|
|
</ScrollView>
|
|
```
|
|
|
|
```
|
|
No language indicated, so no syntax highlighting.
|
|
But let's throw in a <b>tag</b>.
|
|
```
|
|
|
|
---
|
|
|
|
## Tables
|
|
|
|
Colons can be used to align columns.
|
|
|
|
| Tables | Are | Cool |
|
|
| ------------- |:-------------:| -----:|
|
|
| col 3 is | right-aligned | $1600 |
|
|
| col 2 is | centered | $12 |
|
|
| zebra stripes | are neat | $1 |
|
|
|
|
There must be at least 3 dashes separating each header cell.
|
|
The outer pipes (|) are optional, and you don't need to make the
|
|
raw Markdown line up prettily. You can also use inline Markdown.
|
|
|
|
Markdown | Less | Pretty
|
|
--- | --- | ---
|
|
*Still* | `renders` | **nicely**
|
|
1 | 2 | 3
|
|
|
|
---
|
|
|
|
## Blockquotes
|
|
|
|
> Blockquotes are very handy in email to emulate reply text.
|
|
> This line is part of the same quote.
|
|
|
|
Quote break.
|
|
|
|
> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote.
|
|
|
|
Nested quotes
|
|
> Hello!
|
|
>> And to you!
|
|
|
|
---
|
|
|
|
## Inline HTML
|
|
|
|
```html
|
|
<u><i>H<sup>T<sub>M</sub></sup><b><s>L</s></b></i></u>
|
|
```
|
|
|
|
<u><i>H<sup>T<sub>M</sub></sup><b><s>L</s></b></i></u>
|
|
|
|
---
|
|
|
|
## Horizontal Rule
|
|
|
|
Three or more...
|
|
|
|
---
|
|
|
|
Hyphens (`-`)
|
|
|
|
***
|
|
|
|
Asterisks (`*`)
|
|
|
|
___
|
|
|
|
Underscores (`_`)
|
|
|
|
|
|
## License
|
|
|
|
```
|
|
Copyright 2017 Dimitry Ivanov (mail@dimitryivanov.ru)
|
|
|
|
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.
|
|
```
|
|
|
|
[cheatsheet]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
|
|
|
|
[arbitrary case-insensitive reference text]: https://www.mozilla.org
|
|
[1]: http://slashdot.org
|
|
[link text itself]: http://www.reddit.com
|