Update documentation to 4.0.0

This commit is contained in:
Dimitry Ivanov 2019-07-01 19:50:33 +03:00
parent 1407ae0cf8
commit aa64aa7020
7 changed files with 53 additions and 61 deletions

View File

@ -12,12 +12,12 @@ module.exports = {
], ],
themeConfig: { themeConfig: {
nav: [ nav: [
{ text: 'Install', link: '/docs/v3/install.md' }, { text: 'Install', link: '/docs/v4/install.md' },
{ {
text: 'API Version', text: 'API Version',
items: [ items: [
{ text: 'Current (3.x.x)', link: '/' }, { text: 'Current (4.x.x)', link: '/' },
{ text: 'Beta (4.x.x)', link: '/docs/v4/install.md' }, { text: 'Legacy (3.x.x)', link: '/docs/v3/install.md' },
{ text: 'Legacy (2.x.x)', link: '/docs/v2/' } { text: 'Legacy (2.x.x)', link: '/docs/v2/' }
] ]
}, },
@ -36,42 +36,8 @@ module.exports = {
'/docs/v2/html.md', '/docs/v2/html.md',
'/docs/v2/view.md' '/docs/v2/view.md'
], ],
'/docs/v4': [ '/docs/v3': [
'/docs/v4/install.md', '/docs/v3/install.md',
{
title: 'Core',
collapsable: false,
children: [
'/docs/v4/core/getting-started.md',
'/docs/v4/core/plugins.md',
'/docs/v4/core/registry.md',
'/docs/v4/core/theme.md',
'/docs/v4/core/configuration.md',
'/docs/v4/core/visitor.md',
'/docs/v4/core/spans-factory.md',
'/docs/v4/core/core-plugin.md',
'/docs/v4/core/movement-method-plugin.md',
'/docs/v4/core/render-props.md'
]
},
'/docs/v4/ext-latex/',
'/docs/v4/ext-strikethrough/',
'/docs/v4/ext-tables/',
'/docs/v4/ext-tasklist/',
'/docs/v4/html/',
'/docs/v4/image/',
'/docs/v4/image-glide/',
'/docs/v4/image-picasso/',
'/docs/v4/linkify/',
'/docs/v4/recycler/',
'/docs/v4/recycler-table/',
'/docs/v4/simple-ext/',
'/docs/v4/syntax-highlight/',
'/docs/v4/recipes.md',
'/docs/v4/migration-3-4.md'
],
'/': [
'',
{ {
title: 'Core', title: 'Core',
collapsable: false, collapsable: false,
@ -101,8 +67,41 @@ module.exports = {
'/docs/v3/recycler-table/', '/docs/v3/recycler-table/',
'/docs/v3/syntax-highlight/', '/docs/v3/syntax-highlight/',
'/docs/v3/migration-2-3.md' '/docs/v3/migration-2-3.md'
],
'/': [
'',
{
title: 'Core',
collapsable: false,
children: [
'/docs/v4/core/getting-started.md',
'/docs/v4/core/plugins.md',
'/docs/v4/core/registry.md',
'/docs/v4/core/theme.md',
'/docs/v4/core/configuration.md',
'/docs/v4/core/visitor.md',
'/docs/v4/core/spans-factory.md',
'/docs/v4/core/core-plugin.md',
'/docs/v4/core/movement-method-plugin.md',
'/docs/v4/core/render-props.md'
] ]
}, },
'/docs/v4/ext-latex/',
'/docs/v4/ext-strikethrough/',
'/docs/v4/ext-tables/',
'/docs/v4/ext-tasklist/',
'/docs/v4/html/',
'/docs/v4/image/',
'/docs/v4/image-glide/',
'/docs/v4/image-picasso/',
'/docs/v4/linkify/',
'/docs/v4/recycler/',
'/docs/v4/recycler-table/',
'/docs/v4/simple-ext/',
'/docs/v4/syntax-highlight/',
'/docs/v4/recipes.md'
],
},
sidebarDepth: 2, sidebarDepth: 2,
lastUpdated: true lastUpdated: true
} }

View File

@ -5,7 +5,7 @@ title: 'Introduction'
<img :src="$withBase('/art/markwon_logo.png')" alt="Markwon Logo" width="50%"> <img :src="$withBase('/art/markwon_logo.png')" alt="Markwon Logo" width="50%">
<br><br> <br><br>
[![markwon](https://img.shields.io/maven-central/v/ru.noties.markwon/core.svg?label=markwon)](http://search.maven.org/#search|ga|1|g%3A%22ru.noties.markwon%22%20) [![markwon](https://img.shields.io/maven-central/v/io.noties.markwon/core.svg?label=markwon)](http://search.maven.org/#search|ga|1|g%3A%22io.noties.markwon%22%20)
[![Build Status](https://travis-ci.org/noties/Markwon.svg?branch=master)](https://travis-ci.org/noties/Markwon) [![Build Status](https://travis-ci.org/noties/Markwon.svg?branch=master)](https://travis-ci.org/noties/Markwon)
**Markwon** is a markdown library for Android. It parses markdown following **Markwon** is a markdown library for Android. It parses markdown following
@ -27,17 +27,17 @@ listed in <Link name="commonmark-spec" /> are supported (including support for *
* Strong emphasis (`**`, `__`) * Strong emphasis (`**`, `__`)
* Headers (`#{1,6}`) * Headers (`#{1,6}`)
* Links (`[]()` && `[][]`) * Links (`[]()` && `[][]`)
* [Images](/docs/v3/core/images.md) * [Images](/docs/v4/image/)
* Thematic break (`---`, `***`, `___`) * Thematic break (`---`, `***`, `___`)
* Quotes & nested quotes (`>{1,}`) * Quotes & nested quotes (`>{1,}`)
* Ordered & non-ordered lists & nested ones * Ordered & non-ordered lists & nested ones
* Inline code * Inline code
* Code blocks * Code blocks
* [Strike-through](/docs/v3/ext-strikethrough/) (`~~`) * [Strike-through](/docs/v4/ext-strikethrough/) (`~~`)
* [Tables](/docs/v3/ext-tables/) (*with limitations*) * [Tables](/docs/v4/ext-tables/) (*with limitations*)
* [Syntax highlight](/docs/v3/syntax-highlight/) * [Syntax highlight](/docs/v4/syntax-highlight/)
* [LaTeX](/docs/v3/ext-latex/) formulas * [LaTeX](/docs/v4/ext-latex/) formulas
* [HTML](/docs/v3/html/) * [HTML](/docs/v4/html/)
* Emphasis (`<i>`, `<em>`, `<cite>`, `<dfn>`) * Emphasis (`<i>`, `<em>`, `<cite>`, `<dfn>`)
* Strong emphasis (`<b>`, `<strong>`) * Strong emphasis (`<b>`, `<strong>`)
* SuperScript (`<sup>`) * SuperScript (`<sup>`)
@ -49,9 +49,9 @@ listed in <Link name="commonmark-spec" /> are supported (including support for *
* Images (`img` will require configured image loader) * Images (`img` will require configured image loader)
* Blockquote (`blockquote`) * Blockquote (`blockquote`)
* Heading (`h1`, `h2`, `h3`, `h4`, `h5`, `h6`) * Heading (`h1`, `h2`, `h3`, `h4`, `h5`, `h6`)
* there is support to render any HTML tag, but it will require to create a special `TagHandler`, * there is support to render any HTML/XML tag, but it will require to create a special `TagHandler`,
more information can be found in [HTML section](/docs/v3/core/html-renderer.md) more information can be found in [HTML section](/docs/v4/html/#taghandler)
* [Task lists](/docs/v3/ext-tasklist/): * [Task lists](/docs/v4/ext-tasklist/):
<ul style="list-style-type: none; margin: 0; padding: 0;"> <ul style="list-style-type: none; margin: 0; padding: 0;">
<li><input type="checkbox" disabled>Not <i>done</i></li> <li><input type="checkbox" disabled>Not <i>done</i></li>
<li><input type="checkbox" disabled checked><strong>Done</strong> with <code>X</code></li> <li><input type="checkbox" disabled checked><strong>Done</strong> with <code>X</code></li>

View File

@ -56,7 +56,7 @@ myTableWidget.setTable(table);
:::tip :::tip
To take advantage of this functionality and render tables without limitations (including To take advantage of this functionality and render tables without limitations (including
horizontally scrollable layout when its contents exceed screen width), refer to [recycler-table](/docs/v3/recycler-table/) horizontally scrollable layout when its contents exceed screen width), refer to [recycler-table](/docs/v4/recycler-table/)
module documentation that adds support for rendering `TableBlock` markdown node inside Android-native `TableLayout` widget. module documentation that adds support for rendering `TableBlock` markdown node inside Android-native `TableLayout` widget.
::: :::

View File

@ -56,7 +56,7 @@ myTableWidget.setTable(table);
:::tip :::tip
To take advantage of this functionality and render tables without limitations (including To take advantage of this functionality and render tables without limitations (including
horizontally scrollable layout when its contents exceed screen width), refer to [recycler-table](/docs/v3/recycler-table/) horizontally scrollable layout when its contents exceed screen width), refer to [recycler-table](/docs/v4/recycler-table/)
module documentation that adds support for rendering `TableBlock` markdown node inside Android-native `TableLayout` widget. module documentation that adds support for rendering `TableBlock` markdown node inside Android-native `TableLayout` widget.
::: :::

View File

@ -1,7 +0,0 @@
# Migration 3.x.x -> 4.x.x
* maven group-id is changed: `io.noties.markwon` (was `ru.noties.markwon`)
* root package-name is changed: `io.noties.markwon` (was `ru.noties.markwon`)
* `androidx` packages
todo

View File

@ -2,7 +2,7 @@
<MavenBadge4 :artifact="'recycler-table'" /> <MavenBadge4 :artifact="'recycler-table'" />
Artifact that provides [MarkwonAdapter.Entry](/docs/v3/recycler/) to render `TableBlock` inside Artifact that provides [MarkwonAdapter.Entry](/docs/v4/recycler/) to render `TableBlock` inside
Android-native `TableLayout` widget. Android-native `TableLayout` widget.
<img :src="$withBase('/assets/recycler-table-screenshot.png')" alt="screenshot" width="45%"> <img :src="$withBase('/assets/recycler-table-screenshot.png')" alt="screenshot" width="45%">

View File

@ -149,5 +149,5 @@ parsed only once and each subsequent adapter binding call will reuse previously
:::tip Tables :::tip Tables
There is a standalone artifact that adds support for displaying markdown tables There is a standalone artifact that adds support for displaying markdown tables
natively via `TableLayout`. Please refer to its [documentation](/docs/v3/recycler-table/) natively via `TableLayout`. Please refer to its [documentation](/docs/v4/recycler-table/)
::: :::