org.jbake.app

Interface ConfigUtil.Keys

Enclosing class:

ConfigUtil

public static interface ConfigUtil.Keys

Set of config keys used by JBake

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARCHIVE_FILE Output filename for archive file, is only used when RENDER_ARCHIVE is true
static java.lang.String	ASCIIDOCTOR_ATTRIBUTES Asciidoctor attributes to be set when processing input
static java.lang.String	ASCIIDOCTOR_ATTRIBUTES_EXPORT Flag indicating if JBake properties should be made available to Asciidoctor
static java.lang.String	ASCIIDOCTOR_ATTRIBUTES_EXPORT_PREFIX Prefix to be used when exporting JBake properties to Asciidoctor
static java.lang.String	ASCIIDOCTOR_OPTION Asciidoctor options to be set when processing input
static java.lang.String	ASSET_FOLDER Folder where assets are stored, they are copied directly in output folder and not processed
static java.lang.String	ASSET_IGNORE_HIDDEN Flag indicating if hidden asset resources should be ignored
static java.lang.String	BUILD_TIMESTAMP Timestamp that records when JBake build was made
static java.lang.String	CONTENT_FOLDER Folder where content (that's to say files to be transformed) resides in
static java.lang.String	DATE_FORMAT How date is formated
static java.lang.String	DB_PATH Folder to store database files in
static java.lang.String	DB_STORE Flag to identify if database is kept in memory (memory) or persisted to disk (local)
static java.lang.String	DEFAULT_STATUS Default status to use (in order to avoid putting it in all files)
static java.lang.String	DEFAULT_TYPE Default type to use (in order to avoid putting it in all files)
static java.lang.String	DESTINATION_FOLDER Folder where rendered files are output
static java.lang.String	DRAFT_SUFFIX Suffix used to identify draft files
static java.lang.String	FEED_FILE Output filename for feed file, is only used when RENDER_FEED is true
static java.lang.String	INDEX_FILE Output filename for index, is only used when RENDER_INDEX is true
static java.lang.String	OUTPUT_EXTENSION File extension to be used for all output files
static java.lang.String	PAGINATE_INDEX Flag indicating if there should be pagination when rendering index
static java.lang.String	POSTS_PER_PAGE How many posts per page on index
static java.lang.String	RENDER_ARCHIVE Flag indicating if archive file should be generated
static java.lang.String	RENDER_ENCODING Encoding used when rendering files
static java.lang.String	RENDER_FEED Flag indicating if feed file should be generated
static java.lang.String	RENDER_INDEX Flag indicating if index file should be generated
static java.lang.String	RENDER_SITEMAP Flag indicating if sitemap file should be generated
static java.lang.String	RENDER_TAGS Flag indicating if tag files should be generated
static java.lang.String	RENDER_TAGS_INDEX Flag indicating if tag index file should be generated
static java.lang.String	SERVER_PORT Port used when running Jetty server
static java.lang.String	SITE_HOST The configured base URI for the hosted content
static java.lang.String	SITEMAP_FILE Sitemap template file name.
static java.lang.String	TAG_PATH Tags output path, used only when RENDER_TAGS is true
static java.lang.String	TAG_SANITIZE Should the tag value be sanitized?
static java.lang.String	TEMPLATE_ENCODING Encoding to be used for template files
static java.lang.String	TEMPLATE_FOLDER Folder where template files are looked for
static java.lang.String	THYMELEAF_LOCALE Locale used for Thymeleaf template rendering
static java.lang.String	URI_NO_EXTENSION Flag indicating if content matching prefix below should be given extension-less URI's
static java.lang.String	URI_NO_EXTENSION_PREFIX URI prefix for content that should be given extension-less output URI's
static java.lang.String	VERSION Version of JBake

Field Detail

ARCHIVE_FILE

static final java.lang.String ARCHIVE_FILE

Output filename for archive file, is only used when RENDER_ARCHIVE is true

See Also:

Constant Field Values

ASCIIDOCTOR_ATTRIBUTES

static final java.lang.String ASCIIDOCTOR_ATTRIBUTES

Asciidoctor attributes to be set when processing input

See Also:

Constant Field Values

ASCIIDOCTOR_ATTRIBUTES_EXPORT

static final java.lang.String ASCIIDOCTOR_ATTRIBUTES_EXPORT

Flag indicating if JBake properties should be made available to Asciidoctor

See Also:

Constant Field Values

ASCIIDOCTOR_ATTRIBUTES_EXPORT_PREFIX

static final java.lang.String ASCIIDOCTOR_ATTRIBUTES_EXPORT_PREFIX

Prefix to be used when exporting JBake properties to Asciidoctor

See Also:

Constant Field Values

ASCIIDOCTOR_OPTION

static final java.lang.String ASCIIDOCTOR_OPTION

Asciidoctor options to be set when processing input

See Also:

Constant Field Values

ASSET_FOLDER

static final java.lang.String ASSET_FOLDER

Folder where assets are stored, they are copied directly in output folder and not processed

See Also:

Constant Field Values

URI_NO_EXTENSION

static final java.lang.String URI_NO_EXTENSION

Flag indicating if content matching prefix below should be given extension-less URI's

See Also:

Constant Field Values

URI_NO_EXTENSION_PREFIX

static final java.lang.String URI_NO_EXTENSION_PREFIX

URI prefix for content that should be given extension-less output URI's

See Also:

Constant Field Values

ASSET_IGNORE_HIDDEN

static final java.lang.String ASSET_IGNORE_HIDDEN

Flag indicating if hidden asset resources should be ignored

See Also:

Constant Field Values

BUILD_TIMESTAMP

static final java.lang.String BUILD_TIMESTAMP

Timestamp that records when JBake build was made

See Also:

Constant Field Values

CONTENT_FOLDER

static final java.lang.String CONTENT_FOLDER

Folder where content (that's to say files to be transformed) resides in

See Also:

Constant Field Values

DATE_FORMAT

static final java.lang.String DATE_FORMAT

How date is formated

See Also:

Constant Field Values

DB_PATH

static final java.lang.String DB_PATH

Folder to store database files in

See Also:

Constant Field Values

DB_STORE

static final java.lang.String DB_STORE

Flag to identify if database is kept in memory (memory) or persisted to disk (local)

See Also:

Constant Field Values

DEFAULT_STATUS

static final java.lang.String DEFAULT_STATUS

Default status to use (in order to avoid putting it in all files)

See Also:

Constant Field Values

DEFAULT_TYPE

static final java.lang.String DEFAULT_TYPE

Default type to use (in order to avoid putting it in all files)

See Also:

Constant Field Values

DESTINATION_FOLDER

static final java.lang.String DESTINATION_FOLDER

Folder where rendered files are output

See Also:

Constant Field Values

DRAFT_SUFFIX

static final java.lang.String DRAFT_SUFFIX

Suffix used to identify draft files

See Also:

Constant Field Values

FEED_FILE

static final java.lang.String FEED_FILE

Output filename for feed file, is only used when RENDER_FEED is true

See Also:

Constant Field Values

INDEX_FILE

static final java.lang.String INDEX_FILE

Output filename for index, is only used when RENDER_INDEX is true

See Also:

Constant Field Values

OUTPUT_EXTENSION

static final java.lang.String OUTPUT_EXTENSION

File extension to be used for all output files

See Also:

Constant Field Values

RENDER_ARCHIVE

static final java.lang.String RENDER_ARCHIVE

Flag indicating if archive file should be generated

See Also:

Constant Field Values

RENDER_ENCODING

static final java.lang.String RENDER_ENCODING

Encoding used when rendering files

See Also:

Constant Field Values

RENDER_FEED

static final java.lang.String RENDER_FEED

Flag indicating if feed file should be generated

See Also:

Constant Field Values

RENDER_INDEX

static final java.lang.String RENDER_INDEX

Flag indicating if index file should be generated

See Also:

Constant Field Values

RENDER_SITEMAP

static final java.lang.String RENDER_SITEMAP

Flag indicating if sitemap file should be generated

See Also:

Constant Field Values

RENDER_TAGS

static final java.lang.String RENDER_TAGS

Flag indicating if tag files should be generated

See Also:

Constant Field Values

RENDER_TAGS_INDEX

static final java.lang.String RENDER_TAGS_INDEX

Flag indicating if tag index file should be generated

See Also:

Constant Field Values

SERVER_PORT

static final java.lang.String SERVER_PORT

Port used when running Jetty server

See Also:

Constant Field Values

SITEMAP_FILE

static final java.lang.String SITEMAP_FILE

Sitemap template file name. Used only when RENDER_SITEMAP is set to true

See Also:

Constant Field Values

TAG_PATH

static final java.lang.String TAG_PATH

Tags output path, used only when RENDER_TAGS is true

See Also:

Constant Field Values

TAG_SANITIZE

static final java.lang.String TAG_SANITIZE

Should the tag value be sanitized?

See Also:

Constant Field Values

TEMPLATE_ENCODING

static final java.lang.String TEMPLATE_ENCODING

Encoding to be used for template files

See Also:

Constant Field Values

TEMPLATE_FOLDER

static final java.lang.String TEMPLATE_FOLDER

Folder where template files are looked for

See Also:

Constant Field Values

THYMELEAF_LOCALE

static final java.lang.String THYMELEAF_LOCALE

Locale used for Thymeleaf template rendering

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

Version of JBake

See Also:

Constant Field Values

PAGINATE_INDEX

static final java.lang.String PAGINATE_INDEX

Flag indicating if there should be pagination when rendering index

See Also:

Constant Field Values

POSTS_PER_PAGE

static final java.lang.String POSTS_PER_PAGE

How many posts per page on index

See Also:

Constant Field Values

SITE_HOST

static final java.lang.String SITE_HOST

The configured base URI for the hosted content

See Also:

Constant Field Values