io.freefair.gradle.plugins.mkdocs.MkDocsPlugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mkdocs-plugin Show documentation

Collection of MkDocs related Gradle plugins

There is a newer version: 8.10.2

package io.freefair.gradle.plugins.mkdocs;

import io.freefair.gradle.plugins.mkdocs.tasks.MkDocsBuild;
import io.freefair.gradle.plugins.mkdocs.tasks.MkDocsNew;
import io.freefair.gradle.plugins.mkdocs.tasks.MkDocsServe;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.plugins.BasePlugin;
import org.gradle.api.plugins.BasePluginExtension;
import org.gradle.api.plugins.JavaBasePlugin;
import org.gradle.api.tasks.TaskProvider;
import org.gradle.api.tasks.bundling.Tar;
import org.gradle.api.tasks.bundling.Zip;

public class MkDocsPlugin implements Plugin {

    @Override
    public void apply(Project project) {

        TaskProvider mkdocs = project.getTasks().register("mkdocs", MkDocsBuild.class, mkDocs -> {
            mkDocs.setGroup(JavaBasePlugin.DOCUMENTATION_GROUP);
            mkDocs.getConfigFile().convention(project.getLayout().getProjectDirectory().file("mkdocs.yml"));
            mkDocs.getSiteDir().convention(project.getLayout().getBuildDirectory().dir("docs/mkdocs"));
        });

        TaskProvider mkdocsZip = project.getTasks().register("mkdocsZip", Zip.class, zip -> {
            zip.from(mkdocs);
        });

        TaskProvider mkdocsTar = project.getTasks().register("mkdocsTar", Tar.class, tar -> {
            tar.from(mkdocs);
        });

        project.getPlugins().withType(BasePlugin.class, basePlugin -> {
            BasePluginExtension baseExtension = project.getExtensions().getByType(BasePluginExtension.class);
            DirectoryProperty distsDirectory = baseExtension.getDistsDirectory();
            mkdocsZip.configure(zip -> zip.getDestinationDirectory().convention(distsDirectory));
            mkdocsTar.configure(tar -> tar.getDestinationDirectory().convention(distsDirectory));
        });

        project.getTasks().register("mkdocsNew", MkDocsNew.class, mkDocsNew -> {
            mkDocsNew.setGroup(JavaBasePlugin.DOCUMENTATION_GROUP);
            mkDocsNew.getProjectDirectory().convention(project.getLayout().getProjectDirectory());
        });

        project.getTasks().register("mkdocsServe", MkDocsServe.class, mkdocsServe -> {
            mkdocsServe.setGroup(JavaBasePlugin.DOCUMENTATION_GROUP);
            mkdocsServe.getConfigFile().convention(project.getLayout().getProjectDirectory().file("mkdocs.yml"));
        });
    }
}