Cake.Jekyll

Cake addin that makes Jekyll available in Cake builds. Jekyll is a blog-aware, static site generator in Ruby.

#addin nuget:?package=Cake.Jekyll&version=1.0.0

<package id="Cake.Jekyll" version="1.0.0" />

dotnet add package Cake.Jekyll --version 1.0.0

<PackageReference Include="Cake.Jekyll" Version="1.0.0" />

Aliases

Functions to execute the Jekyll commands in Cake builds.

In order to use this Cake addin, Bundle and/or Jekyll must be installed.

In order to use it, add the following to your Cake build script:

#addin "nuget:?package=Cake.Jekyll&version=x.y.z"
Where `x.y.z` is the version of the Cake.Jekyll package to use (latest version is recommended).

Build

JekyllBuild() Build your site using the default settings.
JekyllBuild(Action<JekyllBuildSettings>) Build your site using the settings returned by a configurator.
JekyllBuild(JekyllBuildSettings) Build your site using the specified settings.

Clean

JekyllClean() Clean your site using the default settings.
JekyllClean(Action<JekyllCleanSettings>) Clean your site using the settings returned by a configurator.
JekyllClean(JekyllCleanSettings) Clean your site using the specified settings.

Doctor

JekyllDoctor() Search your site and print specific deprecation warnings using the default settings.
JekyllDoctor(Action<JekyllDoctorSettings>) Search your site and print specific deprecation warnings using the settings returned by a configurator.
JekyllDoctor(JekyllDoctorSettings) Search your site and print specific deprecation warnings using the specified settings.

New

JekyllNew(DirectoryPath) Create a new Jekyll site scaffold using the default settings.
JekyllNew(DirectoryPath, Action<JekyllNewSettings>) Create a new Jekyll site scaffold using the settings returned by a configurator.
JekyllNew(DirectoryPath, JekyllNewSettings) Create a new Jekyll site scaffold using the specified settings.

NewTheme

JekyllNewTheme(string) Create a new Jekyll theme scaffold using the default settings.
JekyllNewTheme(string, Action<JekyllNewThemeSettings>) Create a new Jekyll theme scaffold using the settings returned by a configurator.
JekyllNewTheme(string, JekyllNewThemeSettings) Create a new Jekyll theme scaffold using the specified settings.

Serve

JekyllServe() Serve your site locally using the default settings.
JekyllServe(Action<JekyllServeSettings>) Serve your site locally using the settings returned by a configurator.
JekyllServe(JekyllServeSettings) Serve your site locally using the specified settings.

Version

JekyllVersion() Print the name and version.
JekyllVersion(Action<JekyllVersionSettings>) Print the name and version using the settings returned by a configurator.
JekyllVersion(JekyllVersionSettings) Print the name and version using the specified settings.