Interface ProjConf

Hierarchy

Indexable

[key: string]: any

Properties

archive_dir author categories? category_dir category_map code_dir cwd date_format default_category default_layout deploy description exclude external_link filename_case future generator highlight i18n_dir ignore include? language new_post_name pagination_dir per_page permalink permalink_defaults post_asset_folder post_dir public_dir relative_link render_drafts root skip_render source_dir subtitle tag_dir tag_map tags? theme theme_config time_format timezone title titlecase url

Properties

Readonly archive_dir

archive_dir: string

Archive directory

Readonly author

author: string

Your name

Optional categories

categories?: LabelMapper

Categories mapper

Readonly category_dir

category_dir: string

Category directory

Readonly category_map

category_map: {
    [key: string]: string | number;
}

Category slugs

Type declaration

  • [key: string]: string | number

Readonly code_dir

code_dir: string

Include code directory (subdirectory of source_dir)

cwd

cwd: string

Project CWD

Readonly date_format

date_format: string

Date format https://momentjs.com/

Readonly default_category

default_category: string

Default category

Readonly default_layout

default_layout: string

Default layout

deploy

deploy: {
    branch: string;
    deployDir: string;
    email: string;
    github: {
        submodule: never[];
    };
    message: string;
    repo: string;
    type: string;
    username: string;
} & {
    deployDir: string;
    github: git;
}

Deployment options

Readonly description

description: string

The description of your website

exclude

exclude: string[]

global ignore

external_link

external_link: Object

Open external links in a new tab?

Readonly filename_case

filename_case: number

Transform filenames to 1 lower case; 2 upper case

Readonly future

future: boolean

Display future posts?

generator

generator: {
    cache: boolean;
    verbose: boolean;
    [key: string]: any;
}

Type declaration

  • [key: string]: any
  • cache: boolean
  • verbose: boolean

Readonly highlight

highlight: {
    auto_detect: boolean;
    enable: boolean;
    line_number: boolean;
    tab_replace: null | string;
}

Code block settings

Type declaration

  • Readonly auto_detect: boolean
  • Readonly enable: boolean
  • Readonly line_number: boolean
  • Readonly tab_replace: null | string

Readonly i18n_dir

i18n_dir: string

i18n directory

Readonly ignore

ignore: string[]

Optional Readonly include

include?: string[]

Hexo by default ignores hidden files and folders, but setting this field will make Hexo process them

Readonly language

language: string | string[]

The language of your website. Use a 2-lettter ISO-639-1 code. Default is en.

Readonly new_post_name

new_post_name: string

The filename format for new posts

Readonly pagination_dir

pagination_dir: string

Pagination directory

Readonly per_page

per_page: number

The amount of posts displayed on a single page. 0 disables pagination

Readonly permalink

permalink: string

The permalink format of articles

Readonly permalink_defaults

permalink_defaults: null | string

Default values of each segment in permalink

Readonly post_asset_folder

post_asset_folder: boolean

Enable the Asset Folder?

post_dir

post_dir: string

Source posts

Readonly public_dir

public_dir: string

Public folder. Where the static site will be generated

Readonly relative_link

relative_link: boolean

Make links relative to the root folder?

Readonly render_drafts

render_drafts: boolean

Display drafts?

Readonly root

root: string

The root directory of your website

Readonly skip_render

skip_render: null | string | string[]

Paths that will be copied to public raw, without being rendered. You can use glob expressions for path matching.

Readonly source_dir

source_dir: string

Source folder. Where your content is stored

Readonly subtitle

subtitle: string

The subtitle of your website

Readonly tag_dir

tag_dir: string

Tag directory

Readonly tag_map

tag_map: {
    [key: string]: string | number;
}

Tag slugs

Type declaration

  • [key: string]: string | number

Optional tags

tags?: LabelMapper

Tags mapper

Readonly theme

theme: string | false

Theme name. false disables theming

Readonly theme_config

theme_config: {
    [key: string]: string | number;
}

Theme configuration. Include any custom theme settings under this key to override theme defaults.

Type declaration

  • [key: string]: string | number

Readonly time_format

time_format: string

Time format https://momentjs.com/

Readonly timezone

timezone: string

The timezone of your website. Hexo uses the setting on your computer by default. You can find the list of available timezones [here]https://en.wikipedia.org/wiki/List_of_tz_database_time_zones . Some examples are America/New_York , Japan , and UTC .

Readonly title

title: string

The title of your website

Readonly titlecase

titlecase: boolean

Transform titles into title case?

Readonly url

url: string

The URL of your website

Settings

Member Visibility

Theme