Package com.mohamnag.jstatic.plugins.markdown_compiler

Class MarkdownCompilerTask

java.lang.Object

com.mohamnag.jstatic.plugins.markdown_compiler.MarkdownCompilerTask

All Implemented Interfaces:

BuildTask

public class MarkdownCompilerTask
extends Object
implements BuildTask

This plugin compiles markdown on configured source fields of all pages down into HTML and puts it back in the configured target field. Source and target fields might be the same if it is wished to overwrite data.

Multiple pairs of source and target fields can be handled by this plugin.

Constructor Summary

Constructors

Constructor	Description
MarkdownCompilerTask(Config globalConfig)

Method Summary

Modifier and Type	Method	Description
void	run(BuildContext buildContext)
List<Path>	underWatchConfigPaths()	If a plugin depends on config files in addition to the general config file of the application, like functionality extensions stored in files, it shall return these paths here.
List<Path>	underWatchInputPaths()	If a plugin depends on file input, it shall return list of its input paths to be watched for changes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MarkdownCompilerTask

public MarkdownCompilerTask(Config globalConfig)

Method Details

run

public void run(BuildContext buildContext)

Specified by:

run in interface BuildTask

underWatchInputPaths

public List<Path> underWatchInputPaths()

Description copied from interface: BuildTask

If a plugin depends on file input, it shall return list of its input paths to be watched for changes. Paths can be either files or directories. In case of directories, only root path are necessary to be listed and if input path has subdirectories, they will be automatically watched.

Specified by:

underWatchInputPaths in interface BuildTask

underWatchConfigPaths

public List<Path> underWatchConfigPaths()

Description copied from interface: BuildTask

If a plugin depends on config files in addition to the general config file of the application, like functionality extensions stored in files, it shall return these paths here. A change detected in these paths will result in recreation of the plugin.

Specified by:

underWatchConfigPaths in interface BuildTask