misaki.core documentation

Misaki Controll Core

call-all-compile

(call-all-compile)
Call plugin's -compile function for all template files.

call-compile

(call-compile file)(call-compile optional-config file)
Call plugin's -compile function.

call-index-compile

(call-index-compile file)(call-index-compile optional-config file)
Call plugin's -compile function to compile index template defined by :index-template-regexp.

compile*

(compile* file)(compile* optional-config file)
Common function to compile java.io.File with config.

get-post-files

(get-post-files & {:keys [sort? all?], :or {sort? false, all? false}})
Get post files.
Sort file list with `:sort?` option(default setting is FALSE).

get-template-files

(get-template-files & {:keys [dir], :or {dir (:template-dir *config*)}})
Get all template files. Find specified directory with `:dir` option.

get-watch-file-extensions

(get-watch-file-extensions)
Get extensions list to watch.

index-compile*

(index-compile* file)(index-compile* optional-config file)
Common function to compile index file(java.io.File) with config.

process-compile-result

(process-compile-result result default-filename)
Process compile result and return process result.

* string?
  * Write file with default filename.
* true? or false? or symbol?
  * Do nothing.
    * `true`  : Success
    * `false` : Fail
    * `symbol`: Skip
* map?
  * Write file with detailed setting.
    * `:status`  : True(success), false(fail) or something else(skip)
    * `:filename`: Filename to write
    * `:body`    : Compiled body text. if body is nil, only status is checked

update-config

(update-config)(update-config compiler)
Update basic config with plugin's -config function.