hexo-nanoid

Use ai/nanoid to generate abbreviated post links.

Features

• Compatible with hexo new to generate ID for new posts.
• ID validatation on existing posts to ensure the uniqueness.
• Ability to autofix invalid and conflicted post IDs.
• Event nanoid:generate is emitted after each ID generation.

Configuration

The following list shows the descending precedence of config files. (The first one presented is used.)

• Key nanoid in <hexo_root>/_config.yml
• Key theme_config.nanoid in <hexo_root>/_config.yml
• Key nanoid in <hexo_root>/themes/<theme_name>/_config.yml
• Inline default config

1interface HexoNanoIdOptions {
2  /**
3   * Autofix invalid or conflicted IDs.
4   * @default false
5   */
6  autofix: boolean
7
8  /**
9   * Max try to find an unique ID.
10   * @default 10
11   */
12  maxtry: number | "Infinity"
13
14  /**
15   * Ensure the ID uniqueness when creating a new post,
16   * which somewhat slow down the new post generation
17   * since all posts will be loaded and validated.
18   * 
19   * The uniqueness of the new post ID is not guaranteed if this config is set to `false`.
20   * Check https://zelark.github.io/nano-id-cc/ for more info about collision probability.
21   * @default true
22   */
23  check_on_new: boolean
24
25  /***********************************/
26  /*** Configuring nanoid library ***/
27  /***********************************/
28
29  /**
30   * @default 21
31   */
32  length: number
33
34  /**
35   * @default "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz-"
36   */
37  characters?: string
38}