Class MkDocsGhDeploy

  • All Implemented Interfaces:
    java.lang.Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, Configurable<Task>

    public abstract class MkDocsGhDeploy
    extends MkDocs
    Deploy your documentation to GitHub Pages.
    • Constructor Detail

      • MkDocsGhDeploy

        public MkDocsGhDeploy()
    • Method Detail

      • getMessage

        @Optional
        @Input
        public abstract Property<java.lang.String> getMessage()
        A commit message to use when committing to the Github Pages remote branch. Commit {sha} and MkDocs {version} are available as expansions.
      • getRemoteBranch

        @Optional
        @Input
        public abstract Property<java.lang.String> getRemoteBranch()
        The remote branch to commit to for Github Pages. This overrides the value specified in config.
      • getRemoteName

        @Optional
        @Input
        public abstract Property<java.lang.String> getRemoteName()
        The remote name to commit to for Github Pages. This overrides the value specified in config.
      • getForce

        @Optional
        @Input
        public abstract Property<java.lang.Boolean> getForce()
        Force the push to the repository.
      • getIgnoreVersion

        @Optional
        @Input
        public abstract Property<java.lang.Boolean> getIgnoreVersion()
        Ignore check that build is not being deployed with an older version of MkDocs.