Page Assist 开源项目教程

Page Assist 开源项目教程

page-assistUse your locally running AI models to assist you in your web browsing项目地址:https://gitcode.com/gh_mirrors/pa/page-assist

项目的目录结构及介绍

Page Assist 是一个用于本地 AI 模型的 Chrome 扩展，其目录结构如下：

page-assist/
├── CONTRIBUTING.md
├── LICENCE
├── README.md
├── bun.lockb
├── package.json
├── page-share.md
├── postcss.config.js
├── tailwind.config.js
├── tsconfig.json
├── wxt.config.ts
├── docs/
├── src/
├── .gitignore
├── .prettierrc.cjs

目录介绍

• CONTRIBUTING.md: 贡献指南文件。
• LICENCE: 项目许可证文件。
• README.md: 项目说明文件。
• bun.lockb: 依赖锁定文件。
• package.json: 项目依赖和脚本配置文件。
• page-share.md: 页面分享功能说明文件。
• postcss.config.js: PostCSS 配置文件。
• tailwind.config.js: Tailwind CSS 配置文件。
• tsconfig.json: TypeScript 配置文件。
• wxt.config.ts: WXT 配置文件。
• docs/: 文档目录。
• src/: 源代码目录。
• .gitignore: Git 忽略文件配置。
• .prettierrc.cjs: Prettier 代码格式化配置文件。

项目的启动文件介绍

Page Assist 的启动文件主要包括 package.json 中的脚本配置和 src/ 目录下的入口文件。

package.json

{
  "scripts": {
    "start": "node src/index.js"
  }
}

src/index.js

这是项目的入口文件，负责启动扩展和初始化相关功能。

项目的配置文件介绍

Page Assist 的配置文件主要包括以下几个：

postcss.config.js

PostCSS 配置文件，用于配置 CSS 处理工具。

module.exports = {
  plugins: {
    tailwindcss: {},
    autoprefixer: {}
  }
}

tailwind.config.js

Tailwind CSS 配置文件，用于自定义 Tailwind CSS 的配置。

module.exports = {
  purge: ['./src/**/*.html'],
  darkMode: false,
  theme: {
    extend: {}
  },
  variants: {
    extend: {}
  },
  plugins: []
}

tsconfig.json

TypeScript 配置文件，用于配置 TypeScript 编译选项。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true
  },
  "include": ["src/**/*"]
}

wxt.config.ts

WXT 配置文件，用于配置 WXT 框架的相关选项。

import { defineConfig } from 'wxt';

export default defineConfig({
  srcDir: 'src',
  outDir: 'dist'
});

以上是 Page Assist 开源项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用该项目。

page-assistUse your locally running AI models to assist you in your web browsing项目地址:https://gitcode.com/gh_mirrors/pa/page-assist