Skip to content

Commit

Permalink
📝 docs: 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
dlzmoe committed Sep 25, 2024
1 parent 485c3ef commit c6d7558
Showing 1 changed file with 52 additions and 55 deletions.
107 changes: 52 additions & 55 deletions README_EN.md
Original file line number Diff line number Diff line change
@@ -1,105 +1,102 @@
<h2 align="center">linuxdo Enhancement Plugin (linuxdo-scripts)</h2>
<p align="center">Scripts are continuously updated. Feel free to raise issues and submit pull requests!</p>
# linuxdo Enhancement Plugin (linuxdo-scripts)

Script updates continuously, and issues and PRs are welcomed!

[简体中文](https://github.com/dlzmoe/linuxdo-scripts/blob/main/README.md) | [English](https://github.com/dlzmoe/linuxdo-scripts/blob/main/README_EN.md)

![Version Badge](https://img.shields.io/github/v/release/dlzmoe/linuxdo-scripts?label=linuxdo%20%E5%A2%9E%E5%BC%BA%E6%8F%92%E4%BB%B6&labelColor=%235D5D5D&color=%23E97435)
![Last Commit Badge](https://img.shields.io/github/last-commit/dlzmoe/linuxdo-scripts)
![Stars Badge](https://img.shields.io/github/stars/dlzmoe%2Flinuxdo-scripts?style=flat)
![License Badge](https://img.shields.io/github/license/dlzmoe/linuxdo-scripts)
![Version](https://img.shields.io/github/v/release/dlzmoe/linuxdo-scripts?label=linuxdo%20%E5%A2%9E%E5%BC%BA%E6%8F%92%E4%BB%B6&labelColor=%235D5D5D&color=%23E97435)
![Last Commit](https://img.shields.io/github/last-commit/dlzmoe/linuxdo-scripts)
![Stars](https://img.shields.io/github/stars/dlzmoe%2Flinuxdo-scripts?style=flat)
![License](https://img.shields.io/github/license/dlzmoe/linuxdo-scripts)

The linux.do enhancement plugin features topic list creation time, floor number display, topics opening in new tabs, forced blocking of certain users' topics, quick replies (customizable), optimized signature images to prevent distortion, direct preview of details and comments in the topic list, import/export for the settings panel, floor lottery, user-defined tags, view only the original poster, automatic scrolling for reading, support for custom CSS styles, mixed Chinese and English layout optimization, level information queries, AI summary of topics, intelligent reply generation, WebDAV synchronization, and theme skin switching for the forum. Features continue to be updated; feel free to propose new ideas!
The linux.do enhancement plugin features topic list creation time display, floor number display, opening topics in new tabs, forced blocking of certain users' topics, quick replies (customizable), optimized signature image display to prevent image breakage, direct preview of details and comments in the topic list, import/export function setting panel, floor lottery, user-defined tags, viewing only the original poster, auto-scrolling reading, support for custom CSS styles, optimized mixed layout of Chinese and English, level information query, AI summary topic functionality, intelligent reply generation, support for WebDAV synchronization, theme skin switching, and continuous feature updates. New ideas are welcomed!

[GitHub Repository](https://github.com/dlzmoe/linuxdo-scripts) |
[Install from Greasyfork](https://greasyfork.org/scripts/501827) |
[Bug Feedback and Feature Requests](https://github.com/dlzmoe/linuxdo-scripts/issues/new/choose) |
[Usage and Development Documentation](https://linuxdo-scripts-docs.netlify.app/) |
[Discord Community](https://discord.gg/n2pErsD7Kg)
[GitHub Repository](https://github.com/dlzmoe/linuxdo-scripts) | [Install from Greasyfork](https://greasyfork.org/scripts/501827) | [Bug Feedback & Feature Requests](https://github.com/dlzmoe/linuxdo-scripts/issues/new/choose) | [Usage & Development Documentation](https://linuxdo-scripts-docs.netlify.app/) | [Discord Community](https://discord.gg/n2pErsD7Kg)

> **Tip**
> Any fun features will be shared in the group chat. It feels like I'm posting too frequently.
> Discord community: https://discord.gg/n2pErsD7Kg
> **TIP:**
> I will share fun features first in the group chat; I feel like I post too frequently.
> Discord Community: https://discord.gg/n2pErsD7Kg
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Usage](#usage)
- [Development Instructions](#development-instructions)
- [Changelog](#changelog)
- [Usage Instructions](#usage-instructions)
- [Development Notes](#development-notes)
- [Change Log](#change-log)
- [Contribution History](#contribution-history)
- [Disclaimer](#disclaimer)
- [Copyright Agreement](#copyright-agreement)
- [License Agreement](#license-agreement)

---

The development environment is Windows / Chrome / Violentmonkey. If you encounter errors or the script does not work with other userscripts managers, try using Violentmonkey (which I currently use; it has good compatibility).
The development environment is Windows / Chrome / Violent Monkey. If you experience errors or ineffectiveness with other userscript managers, please try Violent Monkey (which I'm currently using and has better compatibility).

> **Warning**
> Arc Browser users should use the Violentmonkey extension.
> The tampermonkey extension may not work under Arc Browser due to compatibility issues, which are unrelated to the plugin, being a problem between the browser and the userscripts manager.
> **WARNING:**
> Arc browser users should use the Violent Monkey extension.
> Tampermonkey extensions may not work with the Arc browser due to compatibility issues, which are unrelated to the plugin; the issue lies between the browser and userscript manager.
## Features

- [x] Topic list creation time display
- [x] Floor number display
- [x] Topics open in a new tab
- [x] Forced block of certain users' topics
- [x] Quick replies (customizable)
- [x] Optimized signature image display to prevent distortion
- [x] Import/export for settings panel
- [x] Topic list shows creation time
- [x] Display floor number
- [x] Open topics in new tabs
- [x] Force block (blacklist) certain users' topics
- [x] Quick reply to topics (customizable)
- [x] Optimize signature image display to prevent image breakage
- [x] Import/export function setting panel
- [x] Floor lottery
- [x] View only the original poster toggle
- [x] Automatic scrolling for reading
- [x] View only original poster switch
- [x] Auto-scrolling reading
- [x] Dark mode
- [x] User tag feature
- [x] Direct preview of details and comments in the topic list
- [x] Optimized comment box for emoji
- [x] Comment box emoji optimization
- [x] Support for custom CSS styles
- [x] Mixed Chinese and English layout optimization
- [x] New level information query addition
- [x] Toggle forum emoji style
- [x] AI topic summary feature, intelligent reply generation
- [x] Optimized mixed layout displaying Chinese and English
- [x] New level information query
- [x] Switching forum emoji styles
- [x] AI topic summary functionality, intelligent reply generation
- [x] Support for WebDAV synchronization
- [x] Forum theme skin switching
- [x] Switching forum theme skins

<details>
<summary>Partial screenshot demonstration:</summary>
<summary>Some Screenshot Demos:</summary>

| ![image](https://github.com/user-attachments/assets/c70edbe9-ead1-4a6b-b268-7fc956d3f72f) | ![image](https://github.com/user-attachments/assets/bde3b652-4948-4f00-a825-5f235ebf4d78) |
| ![image](https://github.com/user-attachments/assets/f3fb854f-e6fd-4da4-9a9c-377b6537fab7) | ![image](https://github.com/user-attachments/assets/3b2a9e63-3939-4dbc-a00f-c713ca2c7f33) |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| ![image](https://github.com/user-attachments/assets/05b6510e-0e61-4977-a958-cd8459aaff84) | ![image](https://github.com/user-attachments/assets/4e22e692-85a1-424a-96cc-f39c24b94516) |
| ![image](https://github.com/user-attachments/assets/b9c8626d-03af-4a55-8a92-1f1ebd9a02bf) | ![image](https://github.com/user-attachments/assets/399c1645-36e1-4fe2-a671-ae40685e87ca) |
| ![image](https://github.com/user-attachments/assets/2c67ab9f-2359-4ab5-b0dd-0f257560b98b) | ![image](https://github.com/user-attachments/assets/ed4f925c-e26c-43ce-a886-fa764ac341b5) |
| ![image](https://github.com/user-attachments/assets/c6ba9abb-43aa-40ce-a4a1-b9cdae229a2d) | ![image](https://github.com/user-attachments/assets/399c1645-36e1-4fe2-a671-ae40685e87ca) |

</details>

## Usage
## Usage Instructions

Click this link to automatically trigger the userscripts installation process, which can also prompt for updates in the future.
Click this link to automatically trigger the userscript installation, and subsequent updates can also be triggered.

[Install Script](https://greasyfork.org/scripts/501827)

## Development Instructions
## Development Notes

```
node: v16.15.1
```

Features are developed as components. Each new feature registers a new component to avoid conflicts.
Features are developed as components, and a new component is registered for each new feature to avoid conflicts.

Clone this repository and install dependencies to run the code.
Clone the repository and download dependencies, then run the code:

```shell
git clone https://github.com/dlzmoe/linuxdo-scripts
yarn # install dependencies
yarn dev # run locally
yarn build # build package
yarn # Install dependencies
yarn dev # Run locally
yarn build # Package build
```

The program will automatically trigger local testing.
The program will automatically trigger local tests.

> To automate the construction of release packages, modify the `version` number in `package.json` and write the current version update log in `CHANGELOG.md`.
> Regarding automatic Release package building, modify the `version` number in `package.json` and write the current version change log in `CHANGELOG.md`.
## Changelog
## Change Log

[version-log.md](https://github.com/dlzmoe/linuxdo-scripts/blob/main/version-log.md)

Expand All @@ -111,8 +108,8 @@ The program will automatically trigger local testing.

## Disclaimer

All features provided in this script run only in the browser. The source code used is publicly visible and this script is for research and study purposes only. It does not use any profit schemes or participate in any profit-making organizations. Any disputes arising from or related to the use of this script shall be resolved amicably. The script assumes no responsibility for any loss or damage of any form that may be caused to users themselves or others when using the software provided by this script. By downloading, installing, and using the software provided in this product, the user indicates trust in the author and the related agreements and disclaimers.
All functionalities provided in this script run only in the browser, the source code used is open and transparent, and this script is for learning and research purposes only. It does not use any profit schemes or participate in any profit-related organizations. Any disputes arising from or related to the use of this script should be resolved amicably by all parties. This script does not bear any responsibility for any losses or damages that may occur to users or others while using the software provided in this script. If users download, install, and use the software provided in this product, it indicates that they trust the author and related agreements and disclaimers.

## Copyright Agreement
## License Agreement

[Apache-2.0 license](https://github.com/dlzmoe/linuxdo-scripts/blob/main/LICENSE)

0 comments on commit c6d7558

Please sign in to comment.