Browse Source

docs: add English translations to the README (#1795)

* added english to the readme

* removed english from README.md and added README.en-US.md for english readme

* chore: add language switching

* chore: optimize English sentences

---------

Co-authored-by: 贤心 <3277200+sentsim@users.noreply.github.com>
pull/1828/head
mkerwoodchamp 7 months ago committed by GitHub
parent
commit
ec53be3574
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 82
      README.en-US.md
  2. 24
      README.md

82
README.en-US.md

@ -0,0 +1,82 @@
<div align="center">
<a href="https://layui.dev">
<img src="https://unpkg.com/outeres@0.1.0/img/layui/logo-icon.png" width="81" alt="Layui">
</a>
<h1>Layui</h1>
Classic modular front-end UI library
<p>
<a href="https://www.npmjs.com/package/layui">
<img src="https://img.shields.io/npm/v/layui" alt="Version">
</a>
<a href="https://www.npmjs.com/package/layui">
<img src="https://img.shields.io/github/license/layui/layui" alt="License">
</a>
<a href="https://github.com/layui/layui/blob/2.x/dist/css/layui.css">
<img src="https://img.badgesize.io/layui/layui/2.x/dist/css/layui.css?compression=brotli&label=CSS%20Brotli%20size" alt="CSS Brotli size">
</a>
<a href="https://github.com/layui/layui/blob/2.x/dist/layui.js">
<img src="https://img.badgesize.io/layui/layui/2.x/dist/layui.js?compression=brotli&label=JS%20Brotli%20size" alt="JS Brotli size">
</a>
</p>
[中文](./README.md) · English
</div>
---
Layui constitutes an open-source, freely available Web UI component library implementing its distinct lightweight modular specification. It adheres rigorously to the vanilla HTML/CSS/JavaScript development paradigm, thereby affording unparalleled ease of adoption and immediate usability. Characterized by a minimalist, lightweight aesthetic, the framework's core exudes elegance and richness, with each and every detail, inclusive of documentation, meticulously curated to facilitate swift assembly of web interfaces. Distinguishing itself from prevailing mainstream front-end frameworks, Layui does not contravene established principles but rather espouses a philosophy of reverting to fundamental simplicity. Specifically, it caters to pragmatic individuals with a penchant for simplicity, obviating the need for engagement with diverse build tools. it empowers users to intuitively harness and orchestrate the requisite page elements and interactive behaviors directly within the browser environment.
## Usage
To use Layui, simply include the core files in your page, such as:
```html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Quick Start - Layui</title>
<link href="./layui/css/layui.css" rel="stylesheet" />
</head>
<body>
<!-- HTML Content -->
<script src="./layui/layui.js"></script>
<script>
// Usage
layui.use(function () {
var layer = layui.layer;
// Welcome
layer.msg("Hello World", { icon: 6 });
});
</script>
</body>
</html>
```
## Documentation
[**Current version**](https://layui.dev/docs/2/)
## Contributors
[Project contributors](https://github.com/layui/layui/graphs/contributors)
## Break with the old and establish the new 🌱
On October 14, 2016, Layui released its first version `1.0.0`, after which it was widely adopted across web platforms.
On October 13, 2021, Layui announced the decommissioning of its original official website (<a href="https://unpkg.com/outeres@0.0.7/img/layui/notice-2021.png" target="_blank">details</a>) and migrated its documentation site to Gitee Pages. Concurrently, community management and daily maintenance activities were fully transitioned to both Gitee and Github platforms, encouraging users to embrace other superior mainstream frameworks. This move inadvertently led some to believe that Layui had ceased updates. In reality, since then, Layui has remained active on Github and Gitee, never halting updates, progressing from version `2.6.8` at the time to its current latest release.
On April 24, 2023, Layui released version `2.8.0` officially and launched a [new documentation site](https://layui.dev). This marked a sincere comeback and a continuation of its commitment to open-source ideals. We still uphold the perspective expressed in the announcement two years ago, advocating that developers embrace mainstream technologies and nurture an unwavering passion for cutting-edge advancements. **What Layui does is to fill those narrow gaps outside the mainstream**. Although not a mainstream frontend framework, Layui has long transcended being a personal creation of its author, becoming a collective work of all who persist in using it. It continues to underpin numerous projects and represents the efforts of many individuals. As open-source creators, we should walk alongside these dedicated Layui developers.
In the future, Layui will steadfastly accompany all those who hold it dear, jointly substantiating the feasibility of the Layui development model.
## License
Layui is released under the [MIT](https://opensource.org/licenses/MIT) license. Other relevant agreements may also refer to the [Disclaimer](https://gitee.com/layui/layui/blob/main/DISCLAIMER.md).

24
README.md

@ -1,14 +1,14 @@
<p align="center"> <div align="center">
<a href="https://layui.dev"> <a href="https://layui.dev">
<img src="https://unpkg.com/outeres@0.1.0/img/layui/logo-icon.png" width="81" alt="Layui"> <img src="https://unpkg.com/outeres@0.1.0/img/layui/logo-icon.png" width="81" alt="Layui">
</a> </a>
</p>
<h1 align="center">Layui</h1> <h1>Layui</h1>
<p align="center">
Classic modular front-end UI library Classic modular front-end UI library
</p>
<p align="center"> <p>
<a href="https://www.npmjs.com/package/layui"> <a href="https://www.npmjs.com/package/layui">
<img src="https://img.shields.io/npm/v/layui" alt="Version"> <img src="https://img.shields.io/npm/v/layui" alt="Version">
</a> </a>
@ -23,6 +23,10 @@
</a> </a>
</p> </p>
中文 · [English](./README.en-US.md)
</div>
--- ---
Layui 是一套开源免费的 Web UI 组件库,采用自身轻量级模块化规范,遵循原生态的 `HTML/CSS/JavaScript` 开发模式,极易上手,拿来即用。其风格简约轻盈,而内在雅致丰盈,甚至包括文档在内的每一处细节都经过精心雕琢,非常适合网页界面的快速构建。Layui 区别于一众主流的前端框架,却并非逆道而行,而是信奉返璞归真之道。确切地说,它更多是面向于追求简单的务实主义者,即无需涉足各类构建工具,只需面向浏览器本身,便可将页面所需呈现的元素与交互信手拈来。 Layui 是一套开源免费的 Web UI 组件库,采用自身轻量级模块化规范,遵循原生态的 `HTML/CSS/JavaScript` 开发模式,极易上手,拿来即用。其风格简约轻盈,而内在雅致丰盈,甚至包括文档在内的每一处细节都经过精心雕琢,非常适合网页界面的快速构建。Layui 区别于一众主流的前端框架,却并非逆道而行,而是信奉返璞归真之道。确切地说,它更多是面向于追求简单的务实主义者,即无需涉足各类构建工具,只需面向浏览器本身,便可将页面所需呈现的元素与交互信手拈来。
@ -35,10 +39,10 @@ Layui 是一套开源免费的 Web UI 组件库,采用自身轻量级模块化
<!DOCTYPE html> <!DOCTYPE html>
<html> <html>
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Quick Start - Layui</title> <title>Quick Start - Layui</title>
<link href="./layui/css/layui.css" rel="stylesheet"> <link href="./layui/css/layui.css" rel="stylesheet" />
</head> </head>
<body> <body>
<!-- HTML Content --> <!-- HTML Content -->
@ -48,7 +52,7 @@ Layui 是一套开源免费的 Web UI 组件库,采用自身轻量级模块化
layui.use(function () { layui.use(function () {
var layer = layui.layer; var layer = layui.layer;
// Welcome // Welcome
layer.msg('Hello World', {icon: 6}); layer.msg("Hello World", { icon: 6 });
}); });
</script> </script>
</body> </body>

Loading…
Cancel
Save