PageCrypt 使用教程
1. 项目的目录结构及介绍
PageCrypt 是一个用于加密 HTML 文件的开源工具,其目录结构如下:
/web - Web 前端公共网页(decrypt-template.html)
/src/core.ts - pagecrypt 核心库
/src/index.ts - pagecrypt Node.js 库
/src/cli.ts - pagecrypt CLI
/test - 简单测试设置
/scripts - 本地开发任务脚本
目录介绍
/web
:包含用于公共网页的前端文件,主要是解密模板。/src
:包含 pagecrypt 的核心库、Node.js 库和 CLI 工具的源代码。/test
:包含项目的简单测试设置。/scripts
:包含用于本地开发任务的脚本。
2. 项目的启动文件介绍
PageCrypt 的启动文件主要是 /src/index.ts
和 /src/cli.ts
。
/src/index.ts
这是 pagecrypt 的 Node.js 库的入口文件,提供了加密 HTML 文件的功能。
/src/cli.ts
这是 pagecrypt 的命令行接口(CLI)的入口文件,允许用户通过命令行加密 HTML 文件。
3. 项目的配置文件介绍
PageCrypt 没有传统的配置文件,其主要配置通过命令行参数或函数参数进行。
命令行参数
通过命令行使用 pagecrypt 时,可以指定以下参数:
npx pagecrypt <src> <dest> [password] [options]
<src>
:源 HTML 文件路径。<dest>
:目标加密 HTML 文件路径。[password]
:加密密码。[options]
:其他选项,如生成随机密码的长度等。
函数参数
通过 Node.js 库使用 pagecrypt 时,可以调用以下函数:
import { encrypt } from 'pagecrypt';
await encrypt('index.html', 'encrypted.html', 'password');
inputFile
:源 HTML 文件路径。outputFile
:目标加密 HTML 文件路径。password
:加密密码。
以上是 PageCrypt 的基本使用教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助!