Skip to content

Commit

Permalink
📝 docs: 文档更新
Browse files Browse the repository at this point in the history
  • Loading branch information
dlzmoe committed Sep 18, 2024
1 parent 7eea47c commit d23503f
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 64 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ linux.do 增强插件,话题列表显示创建时间,显示楼层数,新
> Discord 社区:https://discord.gg/n2pErsD7Kg
## 目录
- [目录](#目录)
- [功能特性](#功能特性)
- [使用方法](#使用方法)
- [开发说明](#开发说明)
- [更新日志](#更新日志)
- [Star History](#star-history)
- [Contributor](#contributor)
- [贡献历史](#贡献历史)
- [免责声明](#免责声明)
- [License](#license)
- [版权协议](#版权协议)

---

Expand Down Expand Up @@ -111,21 +111,18 @@ yarn build # 打包构建
[version-log.md](https://github.com/dlzmoe/linuxdo-scripts/blob/main/version-log.md)


## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=dlzmoe/linuxdo-scripts&type=Date)](https://star-history.com/#dlzmoe/linuxdo-scripts&Date)


## Contributor
## 贡献历史

![Contributor](https://contrib.rocks/image?repo=dlzmoe/linuxdo-scripts)

[![Star History Chart](https://api.star-history.com/svg?repos=dlzmoe/linuxdo-scripts&type=Date)](https://star-history.com/#dlzmoe/linuxdo-scripts&Date)


## 免责声明

本脚本中提供的所有功能均仅在浏览器中运行,所使用的源代码公开透明可见,且本脚本仅学习研究使用,不使用任何盈利方案或参与任何盈利组织,因使用本脚本引起的或与本脚本有关的任何争议,各方应友好协商解决,本脚本对使用本脚本所提供的软件时可能对用户自己或他人造成的任何形式的损失和伤害不承担任何责任。如用户下载、安装和使用本产品中所提供的软件,即表明用户信任本作者及其相关协议和免责声明。


## License
## 版权协议

[Apache-2.0 license](https://github.com/dlzmoe/linuxdo-scripts/blob/main/LICENSE)
105 changes: 51 additions & 54 deletions README_EN.md
Original file line number Diff line number Diff line change
@@ -1,72 +1,71 @@
## linuxdo Enhancement Plugin (linuxdo-scripts)

Scripts are constantly updated; feel free to propose issues and submit PRs!
<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>

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

![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)
![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)

The linux.do enhancement plugin includes features such as displaying creation time in topic lists, showing floor counts, opening topics in new tabs, forcibly blocking a user's topics, quick reply to topics (customizable), optimizing signature image display to prevent distortion, directly previewing details and comments in the topic list, importing and exporting the feature settings panel, floor lotteries, user-defined tags, "only view the host" mode, automatic scrolling for reading, custom CSS styles, optimized mixed Chinese and English display, level information query, AI summarization of topics, intelligent reply generation, WebDAV synchronization, changing forum theme skin, etc. Features are continually updated, and new ideas are welcome!
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!

[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/) |
[Wechat Group Chat](https://zishu.me/linuxdo-scripts/) |
[Discord Community](https://discord.gg/n2pErsD7Kg)
[Discord Community](https://discord.gg/n2pErsD7Kg)

> **TIP:**
> Any fun features will be shared in the group chat as soon as I can. I feeling I post too frequently.
> Wechat Group Chat: https://zishu.me/linuxdo-scripts/
> 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.
> Wechat group: https://zishu.me/linuxdo-scripts/
> Discord community: https://discord.gg/n2pErsD7Kg
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Usage Instructions](#usage-instructions)
- [Development Notes](#development-notes)
- [Usage](#usage)
- [Development Instructions](#development-instructions)
- [Changelog](#changelog)
- [Star History](#star-history)
- [Contributors](#contributors)
- [Contribution History](#contribution-history)
- [Disclaimer](#disclaimer)
- [License](#license)
- [Copyright Agreement](#copyright-agreement)

---

The development environment is Windows / Chrome / Violentmonkey. If you get errors or it doesn't work with other userscripts managers, try using Violentmonkey (which I'm currently using and has a better compatibility).
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).

> **WARNING:**
> **Warning**
> Arc Browser users should use the Violentmonkey extension.
> The tampermonkey extensions do not work under Arc Browser due to compatibility issues, which is unrelated to the plugin but rather a problem between the browser and userscript managers.
> 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.
## Features

- [x] Display creation time in topic lists
- [x] Show floor counts
- [x] Open topics in new tabs
- [x] Force block (blacklist) a user’s topics
- [x] Quick reply to topics (customizable)
- [x] Optimize signature image display to prevent distortion
- [x] Import and export feature settings panel
- [x] Floor lotteries
- [x] Enable "only view the host" mode
- [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] Floor lottery
- [x] View only the original poster toggle
- [x] Automatic scrolling for reading
- [x] Dark mode
- [x] User tag feature
- [x] Directly preview details and comments in the topic list
- [x] Optimize emoji in comment boxes
- [x] Direct preview of details and comments in the topic list
- [x] Optimized comment box for emoji
- [x] Support for custom CSS styles
- [x] Optimize mixed Chinese and English display
- [x] Introduce level information query
- [x] Switch forum emoji style
- [x] AI summarization of topics, intelligent reply generation
- [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] Support for WebDAV synchronization
- [x] Switch forum theme skin
- [x] Forum theme skin switching

<details>
<summary>Partial Screenshot Demonstration:</summary>
<summary>Partial screenshot demonstration:</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) |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
Expand All @@ -75,21 +74,21 @@ The development environment is Windows / Chrome / Violentmonkey. If you get erro

</details>

## Usage Instructions
## Usage

Click this link to automatically trigger the userscript installation program, which can also prompt updates later.
Click this link to automatically trigger the userscripts installation process, which can also prompt for updates in the future.

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

## Development Notes
## Development Instructions

```
node: v16.15.1
```

Features are developed as components; each new feature will register a new component to avoid conflicts.
Features are developed as components. Each new feature registers a new component to avoid conflicts.

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

```shell
git clone https://github.com/dlzmoe/linuxdo-scripts
Expand All @@ -98,26 +97,24 @@ yarn dev # run locally
yarn build # build package
```

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

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

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

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=dlzmoe/linuxdo-scripts&type=Date)](https://star-history.com/#dlzmoe/linuxdo-scripts&Date)

## Contributors
## Contribution History

![Contributor](https://contrib.rocks/image?repo=dlzmoe/linuxdo-scripts)

[![Star History Chart](https://api.star-history.com/svg?repos=dlzmoe/linuxdo-scripts&type=Date)](https://star-history.com/#dlzmoe/linuxdo-scripts&Date)

## Disclaimer

All features provided in this script run solely in the browser, and the source code used is publicly visible and transparent. This script is only for learning and research purposes, does not utilize any profit schemes or participate in any profit organizations. Any disputes arising from the use of this script or related to it should be resolved amicably by both parties. The script does not bear any responsibility for any loss or damage caused to the user or others when using this software. 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 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.

## License
## Copyright Agreement

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

0 comments on commit d23503f

Please sign in to comment.