Property Detail

• java.lang.String branch

  Target branch name. Github pages branch name by default.

• java.lang.String comment

  Commit message template.

• java.lang.String docPath

  Documentation publishing path (relative to github pages root). By default set to project version (to be published on as '/version/', for example '/1.0.2/'). <p> If documentation needs to be updated after project release (quite often case) or simply not published with the project release, set required version manually ({@code mkdocs.publish.docPath = '1.1').

  Path may represent any folder structure, for example: '/en/12.1/'. Set to null or empty to publish documentation without sub folders (in this case rootRedirect option will be ignored.

• boolean generateVersionsFile

  When multi-version publishing enabled, plugin would generate versions.json file at the root. The format used from mike tool's file (https://github.com/jimporter/mike). This file is required to show version selection list in material theme (just configure it as described in docs for mike).

  On publication, plugin synchronizes existing file with the list of existing folders.

• java.lang.String repoDir

  Folder used for gh-pages repository checkout/update/publish. Use gradle folder to cache gh-pages checkout because eventually it would contain multiple versions which does not have to be loaded (checkout) on each publication.

• java.lang.String repoUri

  Publish repository url. If not set, then the same repository will be used (with different branch). This is quite common for open source projects to publish github pages on the same repository as source (into gh-pages branch).

• boolean rootRedirect

  When enabled, publish additional index.html at the root. Index file will redirect to the published documentation sub folder (last published version).

  Ignored if docPath set to null or empty (multi version publishing not used).

• java.lang.String rootRedirectTo

  Specifies where root redirection should lead. By default, to just published version. Option is useful when aliases used and you want to open alias by default instead of exact version (for example, `latest` alias).

  Plugin would verify that redirect path points to new version folder or one of its aliases and fail otherwise (to prevent incorrect redirections).

• java.lang.String[] versionAliases

  When specified, version would be published in 2 (or more) folders: version itself and alias(es). This is required, for example, to publish the latest documentation into 'latest' folder so user could reference docs with latest instead of version. Another example is 'dev' docs.

• java.lang.String versionTitle

  Sets version name in version switcher. The value would be used only for versions.json generation only and may differ from actual version path (docPath).

  Do nothing when generateVersionsFile disabled.