Publication configuration.
| Type | Name and description |
|---|---|
java.lang.String |
branchTarget branch name. |
java.lang.String |
commentCommit message template. |
java.lang.String |
docPathDocumentation publishing path (relative to github pages root). |
java.lang.String |
repoDirFolder used for gh-pages repository checkout/update/publish. |
java.lang.String |
repoUriPublish repository url. |
boolean |
rootRedirectWhen enabled, publish additional index.html at the root. |
| Methods inherited from class | Name |
|---|---|
class java.lang.Object |
java.lang.Object#wait(), java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Target branch name. Github pages branch name by default.
Commit message template.
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.
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.
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).
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).