hexo-bangumi-gallery/docs/en/config.md

A Hexo plugin, show your anime list in your blog.

# Custom configuration <!-- {docsify-ignore} -->

The configuration fill in the `_config.yml` file.  

## enable

Whether to enable the plugin  

## path

!> `2.0.0` version deprecated, see [path](/en/config?id=path-1)

## api

You can choose the source of anime information to use, either `bgm` ([bgm.tv](https://bgm.tv/)) or `mal` ([MyAnimeList](https://myanimelist.net/)).  

?> To use MyAnimeList API, you need to provide an API Key.  

!> **NOTE:** When using the MyAnimeList API, only `lite` mode is available.  
For more information about the limitations of the MyAnimeList API Key, see [Why is full mode not supported when using the MyAnimeList API?](/en/faq?id=why-is-full-mode-not-supported-when-using-the-myanimelist-api).

## api_key

For users who choose `bgm`, this parameter can be ignored. If you choose `mal`, you **must provide** an API Key.  

?> For details, see [Help#Get MyAnimeList API Key](/en/help?id=get-myanimelist-api-key).    

## user_id

The username of [bgm.tv](https://bgm.tv/) or [MyAnimeList](https://myanimelist.net/). **NOT nickname**.  

## display

Display settings of page

### title(v2.0.0+)

`display` param  
The title of the page. The default is "My list"

### quote(v2.0.0+)

`display` param  
Will be displayed at the top of the page. Delete this parameter or leave it blank to avoid displaying.

### index

`display` param  
Index of the page. planToWatch: `0`, Watching: `1`, Completed: `2`. Default is `1`  

### image_level

`display` param  
The quality of the cover, optional: `l`(large), `c`(common), `m`(medium), `s`(small), `g`(grid). Default is `l`  

?> MyAnimeList API only supports `l` and `m`. When using `mal`, images other than `l` will be displayed as `m`.  

### size

`display` param  
The display mode of the page. The value can be `lite` (lite mode) or `full` (full mode). The default is `lite`  

?> See [Preview](/en/?id=preview)

### name

`display` param  
**Only valid in `lite` mode**. Whether to display the title of the anime. Default is `true`  

### margin

`display` param  
The default interval between each anime is `10`.    
In `lite` mode, it is the interval around the anime, and in `full` mode, it is the interval above and below the anime.  

### page_size

`display` param  
The number of items displayed per page. `24` by default.

### progress

`display` param  
**Only valid in `full` mode**. Whether to display the progress of the anime in `Watching` tab. Default is `true`.  

### lazyload(v1.1.0+)

`display` param  
Whether to enable lazy loading.  
If you want to customize the loading image, you can directly replace `/source/bangumi-gallery/img/loading.gif`, and the replacement image must also be **a gif**. If you want to restore the default placeholder, just delete this file.

!> **NOTE：** Lazy loading is only available over 1.1.0.

## book、bangumi、music、game(v2.0.0+)

`2.0.0` version added the book、music and game module. The configuration items must include `enable` and `path`, and the rest of the configuration items inherit from `display`. If the configuration items of the module are different from the basic configuration, the module's configuration items will be used.

?> **MyAnimeList** only supports `book` and `bangumi` modules.

### enable

The module configuration item, **REQUIRED**  
Whether to enable the module.

### path

The module configuration item, **REQUIRED**  
The path of the page, the default is the name of the module, such as `/book.html` `/bangumi.html`. You can remove the `.html` at the end when accessing.

!> **NOTE:** The page path setting must end with `.html`.

## title

!> `2.0.0` version deprecated, see [title](/en/config?id=titlev200)

## quote

!> `2.0.0` version deprecated, see [quote](/en/config?id=quotev200)