Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
ViggoZ committed Jul 2, 2024
1 parent 2c299cc commit ad595eb
Show file tree
Hide file tree
Showing 3 changed files with 131 additions and 48 deletions.
99 changes: 51 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,78 +1,81 @@
# Pintree

Pintree 是一个开源项目,旨在将浏览器书签导出成导航网站。通过简单的几步操作,就可以将书签转换成一个美观且易用的导航页面。
[English](README.md) | [中文](README.zh.md)

## 项目功能和目标
Pintree is an open-source project aimed at exporting browser bookmarks into a navigation website. With a few simple steps, you can convert your bookmarks into a beautiful and easy-to-use navigation page.

- 导出浏览器书签
- 将书签文件转换成JSON格式
- 生成静态导航网站
## Project Features and Goals

#### 对这个项目感兴趣可以扫码加群,也可以添加我的微信: ```Gift_wei``` 我拉你进开发群
![](/assets/wechat_group.png)
- Export browser bookmarks
- Convert bookmark files to JSON format
- Generate a static navigation website

本项目还没有正式发布,但是已经可以下载测试了,下面是一个简单的教程,按照下面流程操作即可
#### If you are interested in this project, you can scan the QR code to join the group, or add my WeChat: ```Gift_wei```, and I will invite you to the development group.
![](https://github.com/Pintree-io/pintree/blob/main/assets/wechat_group.png)

## 安装和运行
This project is not officially released yet but is available for testing. Here is a simple tutorial; follow the steps below to get started.

### 步骤 1:Fork 项目
## Installation and Usage

在这个页面的右上角,点击 `Fork` 按钮,将项目 Fork 到您的 GitHub 账号中。
### Step 1: Fork the Project

### 步骤 2:下载浏览器书签
Click the `Fork` button at the top right of this page to fork the project to your GitHub account.

1. 打开 Chrome 浏览器。
2. 在地址栏输入 `chrome://bookmarks/` 并按回车键。
3. 在页面右上角,点击三点菜单,选择 `导出书签`
4. 将书签文件保存到您的电脑上。
### Step 2: Download Browser Bookmarks

### 步骤 3:书签文件转换
1. Open Chrome browser.
2. Type `chrome://bookmarks/` in the address bar and press Enter.
3. Click the three-dot menu at the top right of the page and select `Export bookmarks`.
4. Save the bookmark file to your computer.

1. 打开浏览器,访问 [Pintree JSON Converter](https://pintree.io/json-converter) 网站。
2. 点击 `选择文件` 按钮,选择刚才保存的书签文件(HTML 格式)。
3. 点击 `转换` 按钮,网站会自动将书签文件转换为 JSON 格式。
4. 转换完成后,点击 `下载 JSON 文件`,将转换后的文件下载到您的电脑上。
### Step 3: Convert Bookmark File

### 步骤 4:替换 JSON 文件
1. Open your browser and visit [Pintree JSON Converter](https://pintree.io/json-converter).
2. Click the `Choose file` button and select the bookmark file you just saved (in HTML format).
3. Click the `Convert` button, and the website will automatically convert the bookmark file to JSON format.
4. Once the conversion is complete, click `Download JSON file` to download the converted file to your computer.

1. 打开您的 GitHub 账号中的 `pintree` 仓库(即刚才 Fork 的项目)。
2. 点击仓库中的 `json` 文件夹。
3. 点击 `Upload files` 按钮,选择刚才下载的 JSON 文件,并上传。
4. 确保上传的文件命名为 `pintree.json`,并选择 `Commit changes`
### Step 4: Replace JSON File

### 步骤 5:启用 GitHub Pages
1. Open the `pintree` repository in your GitHub account (the project you just forked).
2. Click the `json` folder in the repository.
3. Click the `Upload files` button, select the JSON file you just downloaded, and upload it.
4. Make sure to name the uploaded file `pintree.json` and select `Commit changes`.

1. 在您的 `pintree` 仓库页面,点击 `Settings`
2. 找到 `Pages` 选项。
3.`Source` 下拉菜单中,选择 `gh-pages` 分支,然后点击 `Save`
4. 几分钟后,您的静态网站将会在 `https://yourusername.github.io/pintree` 上可用。记得替换`yourusername`
### Step 5: Enable GitHub Pages

1. In your `pintree` repository page, click `Settings`.
2. Find the `Pages` option.
3. In the `Source` dropdown menu, select the `gh-pages` branch, then click `Save`.
4. After a few minutes, your static website will be available at `https://yourusername.github.io/pintree`. Remember to replace `yourusername`.

---

通过以上步骤,您已经成功完成了 Pintree 项目的安装和运行。如果有任何问题,可以加群获取更多帮助。
## 使用技术
By following the steps above, you have successfully completed the installation and setup of the Pintree project. If you encounter any issues, join the group for more help.

## Technologies Used

- HTML/CSS/JavaScript
- JSON格式处理
- 静态网站托管
- JSON processing
- Static site hosting

## 贡献指南
## Contribution Guide

欢迎贡献代码和提出建议!请遵循以下步骤参与项目:
We welcome contributions and suggestions! Please follow these steps to participate in the project:

1. Fork本仓库:https://github.com/Pintree-io/pintree/tree/main
2. 创建一个新的分支 (`git checkout -b feature/your-feature`)
3. 提交您的修改 (`git commit -am 'Add some feature'`)
4. 推送到分支 (`git push origin feature/your-feature`)
5. 提交一个Pull Request
1. Fork this repository: https://github.com/Pintree-io/pintree/tree/main
2. Create a new branch (`git checkout -b feature/your-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin feature/your-feature`)
5. Submit a Pull Request

请注意,`main` 分支是项目的源代码分支,而 `gh-pages` 分支是打包出来的静态网站代码分支。请在 `main` 分支上进行开发和提交,然后我们会负责将代码打包并发布到 `gh-pages` 分支。
Please note that the `main` branch is for source code, while the `gh-pages` branch is for the static website code. Develop and commit to the `main` branch, and we will handle packaging and publishing to the `gh-pages` branch.

## 联系方式
## Contact Information

如有任何问题或建议,请通过以下方式联系我们:
- 项目网站: [Pintree](https://pintree.io/)
For any questions or suggestions, please contact us through:
- Project website: [Pintree](https://pintree.io/)
- Email: [email protected]
- 微信:```Gift_wei```
- WeChat: ```Gift_wei```

感谢使用和支持!
Thank you for using and supporting Pintree!
80 changes: 80 additions & 0 deletions README.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Pintree

[English](README.md) | [中文](README.zh.md)

Pintree 是一个开源项目,旨在将浏览器书签导出成导航网站。通过简单的几步操作,就可以将书签转换成一个美观且易用的导航页面。

## 项目功能和目标

- 导出浏览器书签
- 将书签文件转换成JSON格式
- 生成静态导航网站

#### 对这个项目感兴趣可以扫码加群,也可以添加我的微信: ```Gift_wei``` 我拉你进开发群
![](https://github.com/Pintree-io/pintree/blob/main/assets/wechat_group.png)

本项目还没有正式发布,但是已经可以下载测试了,下面是一个简单的教程,按照下面流程操作即可

## 安装和运行

### 步骤 1:Fork 项目

在这个页面的右上角,点击 `Fork` 按钮,将项目 Fork 到您的 GitHub 账号中。

### 步骤 2:下载浏览器书签

1. 打开 Chrome 浏览器。
2. 在地址栏输入 `chrome://bookmarks/` 并按回车键。
3. 在页面右上角,点击三点菜单,选择 `导出书签`
4. 将书签文件保存到您的电脑上。

### 步骤 3:书签文件转换

1. 打开浏览器,访问 [Pintree JSON Converter](https://pintree.io/json-converter) 网站。
2. 点击 `选择文件` 按钮,选择刚才保存的书签文件(HTML 格式)。
3. 点击 `转换` 按钮,网站会自动将书签文件转换为 JSON 格式。
4. 转换完成后,点击 `下载 JSON 文件`,将转换后的文件下载到您的电脑上。

### 步骤 4:替换 JSON 文件

1. 打开您的 GitHub 账号中的 `pintree` 仓库(即刚才 Fork 的项目)。
2. 点击仓库中的 `json` 文件夹。
3. 点击 `Upload files` 按钮,选择刚才下载的 JSON 文件,并上传。
4. 确保上传的文件命名为 `pintree.json`,并选择 `Commit changes`

### 步骤 5:启用 GitHub Pages

1. 在您的 `pintree` 仓库页面,点击 `Settings`
2. 找到 `Pages` 选项。
3.`Source` 下拉菜单中,选择 `gh-pages` 分支,然后点击 `Save`
4. 几分钟后,您的静态网站将会在 `https://yourusername.github.io/pintree` 上可用。记得替换`yourusername`

---

通过以上步骤,您已经成功完成了 Pintree 项目的安装和运行。如果有任何问题,可以加群获取更多帮助。
## 使用技术

- HTML/CSS/JavaScript
- JSON格式处理
- 静态网站托管

## 贡献指南

欢迎贡献代码和提出建议!请遵循以下步骤参与项目:

1. Fork本仓库:https://github.com/Pintree-io/pintree/tree/main
2. 创建一个新的分支 (`git checkout -b feature/your-feature`)
3. 提交您的修改 (`git commit -am 'Add some feature'`)
4. 推送到分支 (`git push origin feature/your-feature`)
5. 提交一个Pull Request

请注意,`main` 分支是项目的源代码分支,而 `gh-pages` 分支是打包出来的静态网站代码分支。请在 `main` 分支上进行开发和提交,然后我们会负责将代码打包并发布到 `gh-pages` 分支。

## 联系方式

如有任何问题或建议,请通过以下方式联系我们:
- 项目网站: [Pintree](https://pintree.io/)
- Email: [email protected]
- 微信:```Gift_wei```

感谢使用和支持!
Binary file removed assets/wechat_group.png
Binary file not shown.

0 comments on commit ad595eb

Please sign in to comment.