Shareon 项目使用教程

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

Shareon 是一个轻量级、风格优雅且注重隐私的分享按钮开源项目，适用于流行的社交网络。项目的目录结构如下：

shareon/
├── .github/              # GitHub 相关的配置文件
├── assets/               # 资源文件夹，包括图片、样式表等
├── script/               # JavaScript 脚本文件夹
├── .editorconfig          # 编辑器配置文件
├── .git-blame-ignore-revs # Git 提交忽略文件
├── .gitignore            # Git 忽略文件
├── .pre-commit-config.yaml # pre-commit 配置文件
├── CHANGELOG.md          # 更新日志
├── CONTRIBUTING.md        # 贡献指南
├── LICENSE               # 许可证文件
├── README.md             # 项目说明文件
├── deno.json             # Deno 配置文件
├── index.html            # 项目示例页面
├── package.json          # Node.js 项目配置文件
├── pnpm-lock.yaml        # pnpm 锁定文件
├── svgo.config.js        # SVG 优化配置文件
└── vite.config.js        # Vite 配置文件

2. 项目的启动文件介绍

项目的启动主要通过 index.html 文件来实现。这是项目的入口页面，包含了示例分享按钮的 HTML 代码。以下是启动项目的基本步骤：

1. 将 index.html 文件放置在 Web 服务器目录下。
2. 打开浏览器并访问该 index.html 文件。
3. 页面将显示带有社交网络分享按钮的示例。

3. 项目的配置文件介绍

项目中包含几个配置文件，以下是它们的基本介绍：

• .editorconfig: 这个文件用于定义代码编辑器的配置，以确保不同开发者的编辑器设置保持一致。

• .pre-commit-config.yaml: 这个文件是 pre-commit 工具的配置文件，用于在提交代码前自动执行一些格式化任务。

• package.json: 这是 Node.js 项目的配置文件，定义了项目的依赖、脚本和元数据。

• svgo.config.js: 这是 SVG 优化工具的配置文件，用于优化项目中的 SVG 图片资源。

• vite.config.js: 这是 Vite 的配置文件，用于配置前端构建和开发服务器。

这些配置文件确保了项目在多人协作和持续集成过程中能够保持一定的统一性和自动化。