Index

A E G I M
All Classes and Interfaces|All Packages

A

apply(Project) - Method in class io.freefair.gradle.plugins.mkdocs.MkDocsPlugin

E

exec() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocs

G

getCommand() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocs

getConfigFile() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsBuild

Provide a specific MkDocs config.

getConfigFile() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsGhDeploy

Provide a specific MkDocs config.

getConfigFile() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsServe

Provide a specific MkDocs config.

getDevAddr() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsServe

IP address and port to serve documentation locally (default: localhost:8000)

getDirtyreload() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsServe

Enable the live reloading in the development server, but only re-build files that have changed.

getExecOperations() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocs

getForce() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsGhDeploy

Force the push to the repository.

getIgnoreVersion() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsGhDeploy

Ignore check that build is not being deployed with an older version of MkDocs.

getLivereload() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsServe

Enable the live reloading in the development server

getMessage() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsGhDeploy

A commit message to use when committing to the Github Pages remote branch.

getProjectDirectory() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsNew

getQuiet() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocs

Silence warnings.

getRemoteBranch() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsGhDeploy

The remote branch to commit to for Github Pages.

getRemoteName() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsGhDeploy

The remote name to commit to for Github Pages.

getSiteDir() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsBuild

The directory to output the result of the documentation build.

getStrict() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsBuild

Enable strict mode.

getStrict() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsServe

Enable strict mode.

getTheme() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsBuild

The theme to use when building your documentation.

getTheme() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsServe

The theme to use when building your documentation.

getThemeDir() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsBuild

The theme directory to use when building your documentation.

getThemeDir() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsServe

The theme directory to use when building your documentation.

getVerbose() - Method in class io.freefair.gradle.plugins.mkdocs.tasks.MkDocs

Enable verbose output.

I

io.freefair.gradle.plugins.mkdocs - package io.freefair.gradle.plugins.mkdocs

io.freefair.gradle.plugins.mkdocs.tasks - package io.freefair.gradle.plugins.mkdocs.tasks

M

MkDocs - Class in io.freefair.gradle.plugins.mkdocs.tasks

MkDocs(String) - Constructor for class io.freefair.gradle.plugins.mkdocs.tasks.MkDocs

MkDocsBuild - Class in io.freefair.gradle.plugins.mkdocs.tasks

Build the MkDocs documentation.

MkDocsBuild() - Constructor for class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsBuild

MkDocsGhDeploy - Class in io.freefair.gradle.plugins.mkdocs.tasks

Deploy your documentation to GitHub Pages.

MkDocsGhDeploy() - Constructor for class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsGhDeploy

MkDocsNew - Class in io.freefair.gradle.plugins.mkdocs.tasks

Create a new MkDocs project

MkDocsNew() - Constructor for class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsNew

MkDocsPlugin - Class in io.freefair.gradle.plugins.mkdocs

Gradle plugin for MkDocs documentation generator.

MkDocsPlugin() - Constructor for class io.freefair.gradle.plugins.mkdocs.MkDocsPlugin

MkDocsServe - Class in io.freefair.gradle.plugins.mkdocs.tasks

Run the builtin development server.

MkDocsServe() - Constructor for class io.freefair.gradle.plugins.mkdocs.tasks.MkDocsServe

A E G I M
All Classes and Interfaces|All Packages