diff --git a/docs/.vuepress/components/ArtifactPicker.vue b/docs/.vuepress/components/ArtifactPicker.vue
index 21e2a560..a19ec829 100644
--- a/docs/.vuepress/components/ArtifactPicker.vue
+++ b/docs/.vuepress/components/ArtifactPicker.vue
@@ -34,7 +34,7 @@
import {artifacts} from '../.artifacts.js';
if (!artifacts) {
- throw 'Artifacts not found. Use `collectArtifacts.js` script to obtain artificats metadata.'
+ throw 'Artifacts not found. Use `collectArtifacts.js` script to obtain artifacts metadata.'
}
export default {
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
index 9513401f..5c63daf9 100644
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
@@ -23,9 +23,36 @@ module.exports = {
'/docs/core/getting-started.md'
]
},
- '/docs/configure.md',
- '/docs/theme.md',
- '/docs/factory.md',
+ {
+ title: 'LaTeX extension',
+ children: [
+ '/docs/ext-latex/latex.md'
+ ]
+ },
+ {
+ title: 'Strikethrough extension',
+ children: [
+ '/docs/ext-strikethrough/strikethrough.md'
+ ]
+ },
+ {
+ title: 'Tables extension',
+ children: [
+ '/docs/ext-tables/tables.md'
+ ]
+ },
+ {
+ title: 'Task list extension',
+ children: [
+ '/docs/ext-tasklist/tasklist.md'
+ ]
+ },
+ {
+ title: 'HTML',
+ children: [
+ '/docs/html/html.md'
+ ]
+ },
{
title: 'Image',
children: [
@@ -34,9 +61,18 @@ module.exports = {
'/docs/image/svg.md'
]
},
- '/docs/image-loader.md',
- '/docs/syntax-highlight.md',
- '/docs/html.md',
+ {
+ title: 'Recycler',
+ children: [
+ '/docs/recycler/recycler.md'
+ ]
+ },
+ {
+ title: 'Syntax highlight',
+ children: [
+ '/docs/syntax-highlight/syntax-highlight.md'
+ ]
+ },
'/docs/migration-2-3.md'
],
diff --git a/docs/.vuepress/override.styl b/docs/.vuepress/override.styl
index ed8161b4..08764d10 100644
--- a/docs/.vuepress/override.styl
+++ b/docs/.vuepress/override.styl
@@ -1,2 +1,22 @@
$textColor = #000000
-$accentColor = #4CAF50
\ No newline at end of file
+$accentColor = #4CAF50
+
+a.sidebar-link {
+ font-weight: bold;
+}
+
+.sidebar-sub-headers a.sidebar-link {
+ font-weight: normal;
+}
+
+.sidebar-group a.sidebar-link {
+ font-weight: normal;
+}
+
+.sidebar-heading {
+ color: $textColor;
+}
+
+.sidebar-heading.open, .sidebar-heading:hover {
+ color: $accentColor;
+}
\ No newline at end of file
diff --git a/docs/docs/ext-latex/latex.md b/docs/docs/ext-latex/latex.md
new file mode 100644
index 00000000..d0922cf8
--- /dev/null
+++ b/docs/docs/ext-latex/latex.md
@@ -0,0 +1,7 @@
+---
+title: 'Overview'
+---
+
+# LaTeX extension
+
+
\ No newline at end of file
diff --git a/docs/docs/ext-strikethrough/strikethrough.md b/docs/docs/ext-strikethrough/strikethrough.md
new file mode 100644
index 00000000..ca78dfaa
--- /dev/null
+++ b/docs/docs/ext-strikethrough/strikethrough.md
@@ -0,0 +1,7 @@
+---
+title: 'Overview'
+---
+
+# Strikethrough extension
+
+
\ No newline at end of file
diff --git a/docs/docs/ext-tables/tables.md b/docs/docs/ext-tables/tables.md
new file mode 100644
index 00000000..c8aa89d1
--- /dev/null
+++ b/docs/docs/ext-tables/tables.md
@@ -0,0 +1,7 @@
+---
+title: 'Overview'
+---
+
+# Tables extension
+
+
\ No newline at end of file
diff --git a/docs/docs/ext-tasklist/tasklist.md b/docs/docs/ext-tasklist/tasklist.md
new file mode 100644
index 00000000..0ff1603e
--- /dev/null
+++ b/docs/docs/ext-tasklist/tasklist.md
@@ -0,0 +1,7 @@
+---
+title: 'Overview'
+---
+
+# Task list extension
+
+
\ No newline at end of file
diff --git a/docs/docs/html.md b/docs/docs/html/html.md
similarity index 99%
rename from docs/docs/html.md
rename to docs/docs/html/html.md
index 6130db36..96a75431 100644
--- a/docs/docs/html.md
+++ b/docs/docs/html/html.md
@@ -1,5 +1,11 @@
+---
+title: 'Overview'
+---
+
# HTML
+
+
Starting with version `2.0.0` `Markwon` brings the whole HTML parsing/rendering
stack _on-site_. The main reason for this are _special_ definitions of HTML nodes
by . More specifically:
diff --git a/docs/docs/install.md b/docs/docs/install.md
index 96cfacd9..d1bf8593 100644
--- a/docs/docs/install.md
+++ b/docs/docs/install.md
@@ -10,6 +10,62 @@ next: /docs/core/getting-started.md
+# Bundle
+If you wish to include all Markwon artifacts or add specific artifacts
+in a different manner than explicit gradle dependency definition, you can
+use `markwon-bundle.gradle` gradle script:
+
+*(in your `build.gradle`)*
+```groovy
+apply plugin: 'com.android.application'
+apply from: 'https://raw.githubusercontent.com/noties/Markwon/master/markwon-bundle.gradle'
+
+android { /* */ }
+
+ext.markwon = [
+ 'version': '3.0.0',
+ 'includeAll': true
+]
+
+dependencies { /* */ }
+```
+
+`markwon` object can have these properties:
+* `version` - (required) version of `Markwon`
+* `includeAll` - if _true_ will add all known Markwon artifacts. Can be used with `exclude`
+* * `exclude` - an array of artifacts to _exclude_ (cannot exclude `core`)
+* `artifacts` - an array of artifacts (can omit `core`, as it will be added implicitly anyway)
+
+If `includeAll` property is present and is `true`, then `artifacts` property won't be used.
+If there is no `includeAll` property or if it is `false`, `exclude` property won't be used.
+
+These 2 markwon objects are equal:
+
+```groovy
+// #1
+ext.markwon = [
+ 'version': '3.0.0',
+ 'artifacts': [
+ 'ext-latex',
+ 'ext-strikethrough',
+ 'ext-tables',
+ 'ext-tasklist',
+ 'html',
+ 'image-gif',
+ 'image-okhttp',
+ 'image-svg',
+ 'recycler',
+ 'syntax-highlight'
+ ]
+]
+
+// #2
+ext.markwon = [
+ 'version': '3.0.0',
+ 'includeAll': true
+]
+```
+
## Snapshot
In order to use latest `SNAPSHOT` version add snapshot repository
@@ -25,13 +81,7 @@ allprojects {
}
```
-and then in your module `build.gradle`:
-
-```gradle
-implementation "ru.noties.markwon:core:${markwonSnapshotVersion}"
-```
-
-:::tip
+:::tip Info
All official artifacts share the same version number and all
are uploaded to **release** and **snapshot** repositories
:::
diff --git a/docs/docs/recycler/recycler.md b/docs/docs/recycler/recycler.md
new file mode 100644
index 00000000..3c9188a8
--- /dev/null
+++ b/docs/docs/recycler/recycler.md
@@ -0,0 +1,7 @@
+---
+title: 'Overview'
+---
+
+# Recycler
+
+
\ No newline at end of file
diff --git a/docs/docs/syntax-highlight/syntax-highlight.md b/docs/docs/syntax-highlight/syntax-highlight.md
new file mode 100644
index 00000000..beec2993
--- /dev/null
+++ b/docs/docs/syntax-highlight/syntax-highlight.md
@@ -0,0 +1,7 @@
+---
+title: 'Overview'
+---
+
+# Syntax highlight
+
+
\ No newline at end of file