Hexo Symbols Count Time 插件使用教程

Hexo Symbols Count Time 插件使用教程

1. 项目的目录结构及介绍

Hexo Symbols Count Time 插件的目录结构相对简单，主要包含以下几个部分：

hexo-symbols-count-time/
├── index.js
├── package.json
└── lib/
    └── symbolsCount.js

• index.js: 插件的入口文件，负责初始化和调用其他模块。
• package.json: 包含插件的元数据，如名称、版本、依赖等。
• lib/symbolsCount.js: 核心逻辑文件，负责计算字数和阅读时间。

2. 项目的启动文件介绍

插件的启动文件是 index.js，它主要负责以下任务：

• 引入必要的模块和依赖。
• 注册插件到 Hexo 中。
• 调用 lib/symbolsCount.js 中的逻辑来计算字数和阅读时间。

以下是 index.js 的部分代码示例：

const symbolsCount = require('./lib/symbolsCount');

hexo.extend.filter.register('after_post_render', function(data) {
  data.length = symbolsCount(data.content);
  return data;
});

3. 项目的配置文件介绍

插件的配置文件位于 Hexo 项目的根目录下的 _config.yml 文件中。以下是配置示例：

symbols_count_time:
  symbols: true
  time: true
  total_symbols: true
  total_time: true
  exclude_codeblock: false
  awl: 4
  wpm: 275
  suffix: "mins."

• symbols: 是否显示字数统计。
• time: 是否显示阅读时间。
• total_symbols: 是否显示总字数。
• total_time: 是否显示总阅读时间。
• exclude_codeblock: 是否排除代码块中的字数。
• awl: 平均单词长度（字符数），默认为 4。
• wpm: 每分钟阅读的单词数，默认为 275。
• suffix: 阅读时间单位，默认为 "mins."。

通过这些配置，可以灵活地控制字数和阅读时间的显示方式。