Hexo-Blog-Encrypt 项目安装与使用指南
1. 项目目录结构及介绍
Hexo-Blog-Encrypt 项目的目录结构如下:
hexo-blog-encrypt/
├── lib/
│ ├── editorconfig
│ ├── eslintrc.js
│ ├── gitignore
│ ├── LICENSE
│ ├── README.md
│ ├── README.zh.md
│ ├── index.js
│ └── package.json
├── _config.yml
└── ...
目录结构介绍
-
lib/: 包含项目的主要代码文件。
- editorconfig: 编辑器配置文件。
- eslintrc.js: ESLint 配置文件。
- gitignore: Git 忽略文件配置。
- LICENSE: 项目许可证文件。
- README.md: 项目英文介绍文档。
- README.zh.md: 项目中文介绍文档。
- index.js: 项目入口文件。
- package.json: 项目依赖和配置文件。
-
_config.yml: Hexo 博客的全局配置文件,可以在此文件中配置 Hexo-Blog-Encrypt 插件。
2. 项目启动文件介绍
项目的启动文件是 index.js
,该文件是 Hexo-Blog-Encrypt 插件的入口文件。它负责初始化插件并处理加密和解密逻辑。
主要功能
- 初始化插件: 在 Hexo 启动时加载插件。
- 加密逻辑: 根据配置对博客文章进行加密。
- 解密逻辑: 在用户输入正确密码后解密文章。
3. 项目配置文件介绍
Hexo-Blog-Encrypt 插件的配置主要在 _config.yml
文件中进行。以下是一些关键配置项的介绍:
# Security
encrypt:
enable: true
abstract: 这里有一些加密的内容,需要密码才能继续阅读。
message: 嘿,这里需要密码才能访问。
tags:
- name: encryptAsDiary
password: passwordA
- name: encryptAsTips
password: passwordB
wrong_pass_message: 哦,这是一个无效的密码,请检查并重试。
wrong_hash_message: 哦,这些解密内容无法验证,但你仍然可以查看。
配置项说明
- enable: 是否启用加密功能,设置为
true
启用。 - abstract: 加密文章的摘要,显示在文章列表页。
- message: 密码输入框上方的描述性文字。
- tags: 标签配置,可以为不同标签设置不同的密码。
- wrong_pass_message: 密码错误时的提示信息。
- wrong_hash_message: 解密内容无法验证时的提示信息。
通过以上配置,你可以灵活地控制哪些文章需要加密,并自定义加密和解密的相关提示信息。
以上是 Hexo-Blog-Encrypt 项目的安装与使用指南,希望对你有所帮助。