Working on documentation website structure

This commit is contained in:
Dimitry Ivanov 2019-01-07 17:13:45 +03:00
parent 37ad8effcd
commit 059bc42ac6
11 changed files with 169 additions and 15 deletions

View File

@ -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 {

View File

@ -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'
],

View File

@ -1,2 +1,22 @@
$textColor = #000000
$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;
}

View File

@ -0,0 +1,7 @@
---
title: 'Overview'
---
# LaTeX extension
<MavenBadge :artifact="'ext-latex'" />

View File

@ -0,0 +1,7 @@
---
title: 'Overview'
---
# Strikethrough extension
<MavenBadge :artifact="'ext-strikethrough'" />

View File

@ -0,0 +1,7 @@
---
title: 'Overview'
---
# Tables extension
<MavenBadge :artifact="'ext-tables'" />

View File

@ -0,0 +1,7 @@
---
title: 'Overview'
---
# Task list extension
<MavenBadge :artifact="'ext-tasklist'" />

View File

@ -1,5 +1,11 @@
---
title: 'Overview'
---
# HTML <Badge text="2.0.0" />
<MavenBadge :artifact="'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 <Link name="commonmark-spec" />. More specifically: <Link name="commonmark-spec#inline" displayName="inline" />

View File

@ -10,6 +10,62 @@ next: /docs/core/getting-started.md
<ArtifactPicker />
# Bundle <Badge text="3.0.0" />
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
:::

View File

@ -0,0 +1,7 @@
---
title: 'Overview'
---
# Recycler
<MavenBadge :artifact="'recycler'" />

View File

@ -0,0 +1,7 @@
---
title: 'Overview'
---
# Syntax highlight
<MavenBadge :artifact="'syntax-highlight'" />