hexo-multiple-language-generate

v1.0.4

Published

a month ago

hexo multi-language support plugin

Downloads

143

0High
0Medium
0Low

quillvot

npm hexo hexo multiple-language-generate

Hexo Multiple Language Generate

一个简化 Hexo 博客多语言生成和管理的插件。通过简单配置，轻松实现不同语言版本博客的生成。

English | 日本語 | 简体中文

✨ 特性

🌍 多语言支持 - 为不同语言内容创建独立的语言目录
⚙️ 灵活配置 - 自定义语言设置、URL 结构和输出路径
🔌 轻松集成 - 快速集成到现有 Hexo 项目中
🦋 Butterfly 主题适配 - 针对 Butterfly 主题优化的多语言切换支持
🚀 高效构建 - 优化的构建流程，支持并行处理

📦 安装

npm install hexo-multiple-language-generate --save

🚀 快速开始

1. 前置要求

Node.js (>= 12.0.0)
Hexo (>= 5.0.0)
Butterfly 主题 (可选)

2. 项目结构

.
├── public/                           # 编译输出目录
├── source-en/                        # 英文内容目录
│   ├── _posts/                       # 英文文章
│   └── about/                        # 英文关于页面
├── source-ja/                        # 日文内容目录
│   ├── _posts/                       # 日文文章
│   └── about/                        # 日文关于页面
├── source-zh/                        # 中文内容目录
│   ├── _posts/                       # 中文文章
│   └── about/                        # 中文关于页面
├── config.butterfly.en.yml/          # Butterfly 主题配置文件
├── config.butterfly.ja.yml/
├── config.butterfly.zh.yml/
├── config.en.yml/                    # hexo 基础配置文件
├── config.ja.yml/
├── config.zh.yml/
├── hexo-multiple-language.yml        # 插件配置文件
└── package.json

3. 配置步骤

3.1 创建插件配置文件

复制 hexo-multiple-language.yml 到项目根目录

3.2 语言配置文件调整

在此插件的使用中，不需要原生 Hexo 或 Butterfly 主题中的 _config.yml、_config.butterfly.yml 等配置文件。插件会根据不同语言自动生成对应的配置文件，需手动维护多个语言yml配置。

中文配置 (config.zh.yml)

# URL配置
url: https://quillvot.github.io/
root: /

# 目录配置
source_dir: source-zh
public_dir: public

# 忽略目录
ignore:
  - source-en/
  - source-ja/

英文配置 (config.en.yml)

# URL
url: https://quillvot.github.io/en
root: /en/

# Directory
source_dir: source-en
public_dir: public-en

# Ignore
ignore:
  - source-zh/
  - source-ja/

日文配置 (config.ja.yml)

# URL
url: https://quillvot.github.io/ja
root: /ja/

# ディレクトリ
source_dir: source-ja
public_dir: public-ja

# 除外
ignore:
  - source-zh/
  - source-en/

4. Butterfly 主题配置

为不同语言版本配置导航菜单的语言切换选项：multiple-language-switch

中文 (config.butterfly.zh.yml)

menu:
  语言||fas fa-language:
    English: en || fa-solid fa-language multiple-language-switch
    にほんご: ja || fa-solid fa-language multiple-language-switch
    中文: zh || fa-solid fa-language multiple-language-switch

# 其他 Butterfly 主题配置...

英文 (config.butterfly.en.yml)

menu:
  Language||fas fa-language:
    中文: zh || fa-solid fa-language multiple-language-switch
    にほんご: ja || fa-solid fa-language multiple-language-switch
    English: en || fa-solid fa-language multiple-language-switch

# Other Butterfly theme configurations...

日文 (config.butterfly.ja.yml)

menu:
  げんご||fas fa-language:
    English: en || fa-solid fa-language multiple-language-switch
    中文: zh || fa-solid fa-language multiple-language-switch
    にほんご: ja || fa-solid fa-language multiple-language-switch

# その他の Butterfly テーマ設定...

🔧 使用方法

基本命令

替代原有的 hexo generate 命令：

hexo multiple-language-generate

开发模式

生成并启动本地服务器：

hexo multiple-language-generate && hexo s

部署命令

生成并部署：

hexo multiple-language-generate && hexo deploy

📝 配置参考

hexo-multiple-language.yml 完整配置项

# Hexo多语言站点配置
# 用于生成多语言版本的静态博客站点
hexo-multiple-language:
  # ===== 默认语言配置 =====
  default-language:
    # Hexo默认语言的生成目录
    "generate-dir": "public"

    # 默认语言的配置文件列表
    # 支持设置多个配置文件,按顺序加载并合并
    "config-file-name": [
      "config.zh",           # Hexo主配置文件
      "config.butterfly.zh"  # Butterfly主题配置文件
    ]

  # ===== 其他语言配置 =====
  # 可配置多个其他语言版本
  other-language: [
    {
      "enable": true,              # 是否启用该语言
      "generate-dir": "public-en", # 当前语言的生成目录
      "language-path": "en",       # 生成到主语言目录下的子目录名
      "config-file-name": [
        "config.en",              # 英文版Hexo配置
        "config.butterfly.en"     # 英文版主题配置
      ]
    },
    {
      "enable": true,
      "generate-dir": "public-ja",
      "language-path": "ja",
      "config-file-name": [
        "config.ja",
        "config.butterfly.ja"
      ]
    }
  ]

  # ===== 语言切换配置 =====
  # 基于浏览器语言自动切换或手动切换的相关配置
  switch-language:
    # 是否启用语言切换功能
    enable: true

    # 使用的主题配置文件
    support-theme: "config.butterfly"

    # 手动切换语言后的有效期(单位:毫秒)
    storage-ttl: 100000

    # 当浏览器语言不匹配时使用的默认语言
    not-matched-use: 'en'

    # 默认语言支持的语言代码列表
    default-language: [
      "zh",
      "zh-CN"
    ]

    # 其他语言支持的语言代码映射
    # key: 对应language-path的值
    # value: 该语言支持的语言代码列表，value可配置多个，如 "ja":["ja","en-CA"]，表示浏览器设置的语言是加拿大英语，默认也显示日语
    other-language: {
      "en": ["en"],
      "ja": ["ja"]
    }

🤝 贡献指南

Fork 本仓库
创建特性分支：git checkout -b my-new-feature
提交改动：git commit -am 'Add some feature'
推送分支：git push origin my-new-feature
提交 Pull Request