https://github.com/qiuwenbaike/QiuwenGadgets

求闻系列项目的界面样式、界面脚本和小工具代码库
https://github.com/qiuwenbaike/QiuwenGadgets

mediawiki mediawiki-gadget qiuwen qiuwenbaike

Last synced: 3 months ago
JSON representation

求闻系列项目的界面样式、界面脚本和小工具代码库

• Host: GitHub
• URL: https://github.com/qiuwenbaike/QiuwenGadgets
• Owner: qiuwenbaike
• License: gpl-3.0
• Created: 2023-10-26T11:16:59.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-05-19T14:35:14.000Z (7 months ago)
• Last Synced: 2024-05-21T07:17:30.495Z (7 months ago)
• Topics: mediawiki, mediawiki-gadget, qiuwen, qiuwenbaike
• Language: JavaScript
• Homepage: https://www.qiuwenbaike.cn
• Size: 33.4 MB
• Stars: 0
• Watchers: 0
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![NPM version](https://img.shields.io/npm/v/awesome-gadgets.svg)](https://www.npmjs.com/package/awesome-gadgets)

[![Linter](https://github.com/qiuwenbaike/QiuwenGadgets/actions/workflows/lint.yml/badge.svg)](https://github.com/qiuwenbaike/QiuwenGadgets/actions/workflows/lint.yml)

# _Qiuwen_ Gadgets

## 简介
Introduction

本代码库为[求闻百科][qiuwenbaike]的[界面样式][styles]、[界面脚本][scripts]和[小工具代码库][gadgets]。相关样式表及 JavaScript 优化了求闻百科访客及编者的用户体验，并且为求闻百科用户提供了大量执行常见维护任务的方法。

## 致谢
Acknowledgement

求闻百科小工具库是基于 [Awesome Gadgets][awesome] 打造的。

Awesome Gadgets 是面向 MediaWiki 网站，用以统一存储、管理并编译全站小工具（Gadget）的工具。小工具开发者只需关心小工具本身的代码实现，无需关心其他方面。工具将自动检查语法、编译并部署到网站。
_Awesome Gadgets_ is a tool designed specifically for MediaWiki websites, with the goal of centralizing the storage, management, and compilation of all site-wide CSS/JavaScript and their peer pages. Developers of these gadgets can solely focus on implementing the code for their creations without the need to worry about other aspects. The tool will automatically check the syntax, compile, and deploy gadgets to the website.

-   使用 esbuild 编译，通过 Babel 转译现代语法以获得良好的浏览器兼容性
Compile using esbuild and transpile modern syntax with Babel for good browser compatibility

-   可以编写 TypeScript 和 Less，支持 CSS 和 Less 模块，可以使用 [jsx-dom](https://www.npmjs.com/package/jsx-dom)，可以使用 Vue 组件
Support writing files in TypeScript and Less, support CSS/Less modules, [jsx-dom](https://www.npmjs.com/package/jsx-dom) components and Vue components

    -   见[文档](docs/how-to-use-jsx-and-tsx-with-jsxdom.md)。
See [documentation](docs/how-to-use-jsx-and-tsx-with-jsxdom.md)

    -   见[文档](docs/how-to-use-vue.md)。
See [documentation](docs/how-to-use-vue.md)

-   支持引用 ResourceLoader 模块
Support requiring ResourceLoader built-in modules

    -   见[文档](docs/how-to-use-exports-and-require-in-mediawiki.md)。
See [documentation](docs/how-to-use-exports-and-require-in-mediawiki.md)

-   支持向多个站点部署并独立控制启用与否
Support deploying to multiple sites and independently control whether to enable/disable them

-   自动部署
Automatic deployment

    -   `MediaWiki:Gadgets-definition`

    -   `MediaWiki:Gadget-section-*`（支持自动转换中文变体）/ (with automatic conversion of Chinese variations)

    -   `MediaWiki:Gadget-*`（支持自动转换中文变体）/ (with automatic conversion of Chinese variations)

    -   `MediaWiki:*.{js, css}`

-   自动从网站内删除曾经部署过但现在不再需要的页面
Automatically delete pages that have been deployed on the website but are no longer needed

## 用法
Usage

见[文档](docs/how-to-build-or-deploy.md)。
See [documentation](docs/how-to-build-or-deploy.md).

## 最佳实践
Best practices

-   [QiuwenGadgets](https://github.com/qiuwenbaike/QiuwenGadgets) ([@qiuwenbaike](https://github.com/qiuwenbaike))

[qiuwenbaike]: https://www.qiuwenbaike.cn/

[styles]: https://www.qiuwenbaike.cn/wiki/Help:%E7%95%8C%E9%9D%A2%E6%A0%B7%E5%BC%8F%E4%B8%8E%E8%84%9A%E6%9C%AC#%E7%95%8C%E9%9D%A2%E6%A0%B7%E5%BC%8F

[scripts]: https://www.qiuwenbaike.cn/wiki/Help:%E7%95%8C%E9%9D%A2%E6%A0%B7%E5%BC%8F%E4%B8%8E%E8%84%9A%E6%9C%AC#%E7%95%8C%E9%9D%A2%E8%84%9A%E6%9C%AC

[gadgets]: https://www.qiuwenbaike.cn/wiki/Special:%E5%B0%8F%E5%B7%A5%E5%85%B7

[awesome]: https://github.com/AnYiEE/AwesomeGadgets