From aa64aa70204f9f66f52ceb01a65b9a9ac6019007 Mon Sep 17 00:00:00 2001 From: Dimitry Ivanov Date: Mon, 1 Jul 2019 19:50:33 +0300 Subject: [PATCH] Update documentation to 4.0.0 --- docs/.vuepress/config.js | 79 +++++++++++++-------------- docs/README.md | 20 +++---- docs/docs/v3/ext-tables/README.md | 2 +- docs/docs/v4/ext-tables/README.md | 2 +- docs/docs/v4/migration-3-4.md | 7 --- docs/docs/v4/recycler-table/README.md | 2 +- docs/docs/v4/recycler/README.md | 2 +- 7 files changed, 53 insertions(+), 61 deletions(-) delete mode 100644 docs/docs/v4/migration-3-4.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 95ea14f8..de897e67 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -12,12 +12,12 @@ module.exports = { ], themeConfig: { nav: [ - { text: 'Install', link: '/docs/v3/install.md' }, + { text: 'Install', link: '/docs/v4/install.md' }, { text: 'API Version', items: [ - { text: 'Current (3.x.x)', link: '/' }, - { text: 'Beta (4.x.x)', link: '/docs/v4/install.md' }, + { text: 'Current (4.x.x)', link: '/' }, + { text: 'Legacy (3.x.x)', link: '/docs/v3/install.md' }, { text: 'Legacy (2.x.x)', link: '/docs/v2/' } ] }, @@ -36,42 +36,8 @@ module.exports = { '/docs/v2/html.md', '/docs/v2/view.md' ], - '/docs/v4': [ - '/docs/v4/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' - ], - '/': [ - '', + '/docs/v3': [ + '/docs/v3/install.md', { title: 'Core', collapsable: false, @@ -101,7 +67,40 @@ module.exports = { '/docs/v3/recycler-table/', '/docs/v3/syntax-highlight/', '/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, lastUpdated: true diff --git a/docs/README.md b/docs/README.md index d1acc437..abab2311 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,7 +5,7 @@ title: 'Introduction' Markwon Logo

-[![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) **Markwon** is a markdown library for Android. It parses markdown following @@ -27,17 +27,17 @@ listed in are supported (including support for * * Strong emphasis (`**`, `__`) * Headers (`#{1,6}`) * Links (`[]()` && `[][]`) -* [Images](/docs/v3/core/images.md) +* [Images](/docs/v4/image/) * Thematic break (`---`, `***`, `___`) * Quotes & nested quotes (`>{1,}`) * Ordered & non-ordered lists & nested ones * Inline code * Code blocks -* [Strike-through](/docs/v3/ext-strikethrough/) (`~~`) -* [Tables](/docs/v3/ext-tables/) (*with limitations*) -* [Syntax highlight](/docs/v3/syntax-highlight/) -* [LaTeX](/docs/v3/ext-latex/) formulas -* [HTML](/docs/v3/html/) +* [Strike-through](/docs/v4/ext-strikethrough/) (`~~`) +* [Tables](/docs/v4/ext-tables/) (*with limitations*) +* [Syntax highlight](/docs/v4/syntax-highlight/) +* [LaTeX](/docs/v4/ext-latex/) formulas +* [HTML](/docs/v4/html/) * Emphasis (``, ``, ``, ``) * Strong emphasis (``, ``) * SuperScript (``) @@ -49,9 +49,9 @@ listed in are supported (including support for * * Images (`img` will require configured image loader) * Blockquote (`blockquote`) * Heading (`h1`, `h2`, `h3`, `h4`, `h5`, `h6`) - * there is support to render any HTML tag, but it will require to create a special `TagHandler`, - more information can be found in [HTML section](/docs/v3/core/html-renderer.md) -* [Task lists](/docs/v3/ext-tasklist/): + * 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/v4/html/#taghandler) +* [Task lists](/docs/v4/ext-tasklist/):
  • Not done
  • Done with X
    • diff --git a/docs/docs/v3/ext-tables/README.md b/docs/docs/v3/ext-tables/README.md index 8c75fc21..49282a05 100644 --- a/docs/docs/v3/ext-tables/README.md +++ b/docs/docs/v3/ext-tables/README.md @@ -56,7 +56,7 @@ myTableWidget.setTable(table); :::tip 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. ::: diff --git a/docs/docs/v4/ext-tables/README.md b/docs/docs/v4/ext-tables/README.md index 04df9c5e..403cdb92 100644 --- a/docs/docs/v4/ext-tables/README.md +++ b/docs/docs/v4/ext-tables/README.md @@ -56,7 +56,7 @@ myTableWidget.setTable(table); :::tip 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. ::: diff --git a/docs/docs/v4/migration-3-4.md b/docs/docs/v4/migration-3-4.md deleted file mode 100644 index 8dd6bc5d..00000000 --- a/docs/docs/v4/migration-3-4.md +++ /dev/null @@ -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 \ No newline at end of file diff --git a/docs/docs/v4/recycler-table/README.md b/docs/docs/v4/recycler-table/README.md index 1841e832..b8d9c193 100644 --- a/docs/docs/v4/recycler-table/README.md +++ b/docs/docs/v4/recycler-table/README.md @@ -2,7 +2,7 @@ -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. screenshot diff --git a/docs/docs/v4/recycler/README.md b/docs/docs/v4/recycler/README.md index 2273915e..175d333c 100644 --- a/docs/docs/v4/recycler/README.md +++ b/docs/docs/v4/recycler/README.md @@ -149,5 +149,5 @@ parsed only once and each subsequent adapter binding call will reuse previously :::tip 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/) ::: \ No newline at end of file