A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

apply(Project) - Method in MkdocsPlugin

B

backup() - Method in MkdocsConfig

Backup configuration file.

C

compare(T, T) - Method in VersionsComparator.AlphaDecimalComparator

compare(CharSequence, CharSequence) - Method in VersionsComparator.DecimalComparator

comparingVersions(boolean) - Method in VersionsComparator

contains(String) - Method in MkdocsConfig

Searches for specified property.

copy(Project, String, Object, Map<String, String>) - Method in TemplateUtils

Copies templates from classpath (inside the jar) with placeholders substitution.

D

E

F

find(String) - Method in MkdocsConfig

@param option config option to find

G

getCommand() - Method in MkdocsBuildTask

getConfig() - Method in MkdocsConfig

@return mkdocs config file

getExtension() - Method in MkdocsTask

For use in specialized tasks.

getInstance(boolean) - Method in VersionsComparator.DecimalComparator

getModule() - Method in MkdocsTask

getSourcesDir() - Method in MkdocsBuildTask

H

I

J

K

L

M

MkdocsBuildTask - Class in ru.vyarus.gradle.plugin.mkdocs.task

Builds mkdocs site.

MkdocsConfig - Class in ru.vyarus.gradle.plugin.mkdocs.util

Utility to work with mkdocs config (mkdocs.yml).

MkdocsConfig(Project, String) - Constructor in MkdocsConfig

MkdocsExtension - Class in ru.vyarus.gradle.plugin.mkdocs

Mkdocs plugin extension.

MkdocsExtension.Publish - Class in ru.vyarus.gradle.plugin.mkdocs

Publication configuration.

MkdocsExtension(Project) - Constructor in MkdocsExtension

MkdocsInitTask - Class in ru.vyarus.gradle.plugin.mkdocs.task

Generate initial mkdocs site.

MkdocsPlugin - Class in ru.vyarus.gradle.plugin.mkdocs

Mkdocs plugin.

MkdocsTask - Class in ru.vyarus.gradle.plugin.mkdocs.task

General mkdocs task.

N

O

P

Q

R

resolveComment() - Method in MkdocsExtension

resolveDocPath() - Method in MkdocsExtension

resolveRootRedirectionPath() - Method in MkdocsExtension

resolveVersionTitle() - Method in MkdocsExtension

restoreBackup(File) - Method in MkdocsConfig

Replace current configuration file with provided backup.

reversed() - Method in VersionsComparator.AlphaDecimalComparator

run() - Method in MkdocsBuildTask

run() - Method in MkdocsInitTask

run() - Method in MkdocsTask

run() - Method in VersionsTask

S

set(String, String) - Method in MkdocsConfig

Replace option value in mkdocks config.

setPublish(Closure) - Method in MkdocsExtension

T

TemplateUtils - Class in ru.vyarus.gradle.plugin.mkdocs.util

Utility to extract templates from classpath (plugin jar) and copy to target location with placeholders processing.

U

V

VersionsComparator - Class in ru.vyarus.gradle.plugin.mkdocs.util

A java.util.Comparator for version (or chapter) numbers, which have an arbitrary number of decimal points.

VersionsComparator.AlphaDecimalComparator - Class in ru.vyarus.gradle.plugin.mkdocs.util

The returned comparator compares two character sequences as though each of them would be first transformed into a tuple of the form:

(A0, N0, A1, N1, ..., An-1, Nn-1, An, Nn)

where:

VersionsComparator.AlphaDecimalComparator(Comparator<? super CharSequence>, boolean) - Constructor in VersionsComparator.AlphaDecimalComparator

VersionsComparator.DecimalComparator - Class in ru.vyarus.gradle.plugin.mkdocs.util

The comparator for comparing character sequences that consist solely of decimal digits.

VersionsComparator.DecimalComparator(boolean) - Constructor in VersionsComparator.DecimalComparator

VersionsTask - Class in ru.vyarus.gradle.plugin.mkdocs.task

Generate versions.json file in documentation root folder.

W

X

Y

Z

_