docs: make Chinese README the default
This commit is contained in:
@@ -1,76 +1,82 @@
|
||||
# [💻 LiveTerm - build terminal styled websites in minutes!](https://liveterm.vercel.app)
|
||||
<!-- WEHUB_ZH_README -->
|
||||
> [!NOTE]
|
||||
> 本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。
|
||||
> [English](./README.en.md) · [原始项目](https://github.com/Cveinnt/LiveTerm) · [上游 README](https://github.com/Cveinnt/LiveTerm/blob/HEAD/README.md)
|
||||
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
|
||||
|
||||
Highly customizable, easy-to-use, and minimal terminal styled website template, powered by Next.js.
|
||||
# [💻 LiveTerm - 几分钟即可搭建终端风格网站!](https://liveterm.vercel.app)
|
||||
|
||||
Building a simple website with LiveTerm only takes **minutes**, and you only need to work with **one** file: `config.json`. After you cloned this repository, simply run `yarn install && yarn dev` and start editing `config.json` to build your website!
|
||||
高度可定制、易于使用且极简的终端风格网站模板,基于 Next.js 构建。
|
||||
|
||||
LiveTerm can be used to build a variety of websites:
|
||||
使用 LiveTerm 搭建一个简单的网站只需 **几分钟**,而且你只需要处理 **一个** 文件:`config.json`。克隆此仓库后,只需运行 `yarn install && yarn dev`,然后开始编辑 `config.json` 即可搭建你的网站!
|
||||
|
||||
- [personal website](https://cveinnt.com)
|
||||
- [browser startpage](https://livetermstart.vercel.app/)
|
||||
- [project page](https://liveterm.vercel.app/)
|
||||
- or maybe just a cool browser music player...be creative!
|
||||
LiveTerm 可用于搭建多种网站:
|
||||
|
||||
Feel free to play with the web demo above!
|
||||
- [个人网站](https://cveinnt.com)
|
||||
- [浏览器起始页](https://livetermstart.vercel.app/)
|
||||
- [项目页面](https://liveterm.vercel.app/)
|
||||
- 或者只是一个酷炫的浏览器音乐播放器……发挥创意吧!
|
||||
|
||||
## 📸 Showcase
|
||||
欢迎随意体验上面的 Web 演示!
|
||||
|
||||
## 📸 展示
|
||||
|
||||
<p align="center">
|
||||
<img src="./demo/demo.gif" width="600"><br>
|
||||
<strong>LiveTerm with different themes</strong>
|
||||
<strong>不同主题的 LiveTerm</strong>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img src="./demo/cveinnt.png" width="600"><br>
|
||||
<strong><a href="https://cveinnt.com" target=_blank>my personal website</a></strong>
|
||||
<strong><a href="https://cveinnt.com" target=_blank>我的个人网站</a></strong>
|
||||
</p>
|
||||
|
||||
## 🚀 Ship your LiveTerm site in less than 5 minutes
|
||||
## 🚀 不到 5 分钟即可部署你的 LiveTerm 站点
|
||||
|
||||
LiveTerm requires the `yarn` package manager. You can install `yarn` [here](https://classic.yarnpkg.com/lang/en/docs/install/).
|
||||
LiveTerm 需要 `yarn` 包管理器。你可以在[这里](https://classic.yarnpkg.com/lang/en/docs/install/).)安装 `yarn`。
|
||||
|
||||
Simply run the following commmand in your terminal:
|
||||
只需在终端中运行以下命令:
|
||||
|
||||
```bash
|
||||
sh -c "$(curl -fsSL https://raw.github.com/Cveinnt/LiveTerm/main/install/install.sh)"
|
||||
```
|
||||
|
||||
This will install LiveTerm to the current directory. You can start building your website with:
|
||||
这会将 LiveTerm 安装到当前目录。你可以通过以下方式开始搭建网站:
|
||||
|
||||
```bash
|
||||
cd LiveTerm && yarn dev
|
||||
```
|
||||
|
||||
Start editing `config.json` and try saving and see the updated changes!
|
||||
开始编辑 `config.json`,尝试保存并查看更新后的变化!
|
||||
|
||||
Alternatively, you can clone this repository to a location of your choosing
|
||||
或者,你也可以将此仓库克隆到你选择的位置
|
||||
|
||||
```bash
|
||||
git clone https://github.com/Cveinnt/LiveTerm.git && cd LiveTerm
|
||||
```
|
||||
|
||||
Then install dependencies and start developing there:
|
||||
然后安装依赖并在该位置开始开发:
|
||||
|
||||
```bash
|
||||
yarn install && yarn dev
|
||||
```
|
||||
|
||||
### Docker Usage
|
||||
### Docker 用法
|
||||
|
||||
First, clone the project and edit `config.json` to your liking. Then run the following to start the container in the background:
|
||||
首先,克隆项目并按你的喜好编辑 `config.json`。然后运行以下命令在后台启动容器:
|
||||
|
||||
```shell
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
If you **know** what you were doing, you can also try changing `Dockerfile` & `docker-compose.yml`!
|
||||
Learn more about Docker [here](https://docs.docker.com/get-started/overview/ 'here').
|
||||
如果你**清楚**自己在做什么,也可以尝试修改 `Dockerfile` 和 `docker-compose.yml`!
|
||||
在[这里](https://docs.docker.com/get-started/overview/ 'here')了解更多关于 Docker 的信息。
|
||||
|
||||
## 📄 Configuration
|
||||
## 📄 配置
|
||||
|
||||
### Basic Configuration
|
||||
### 基础配置
|
||||
|
||||
90% of LiveTerm's configurations are done through the `config.json` file.
|
||||
LiveTerm 90% 的配置都通过 `config.json` 文件完成。
|
||||
|
||||
```javascript
|
||||
{
|
||||
@@ -98,34 +104,34 @@ Learn more about Docker [here](https://docs.docker.com/get-started/overview/ 'he
|
||||
}
|
||||
```
|
||||
|
||||
Feel free to change it as you see fit!
|
||||
请随意按你的需求修改!
|
||||
|
||||
### Themes
|
||||
### 主题
|
||||
|
||||
You can find several pre-configured themes in `themes.json`, and you can replace the colors in `config.json` with the theme color you like! The themes are based on the themes on [this website](https://glitchbone.github.io/vscode-base16-term/#/).
|
||||
你可以在 `themes.json` 中找到多个预配置主题,并可以将 `config.json` 中的颜色替换为你喜欢的主题色!这些主题基于[这个网站](https://glitchbone.github.io/vscode-base16-term/#/).)上的主题。
|
||||
|
||||
For a better preview of the themes, checkout the images in the `demo` folder.
|
||||
如需更好地预览主题,请查看 `demo` 文件夹中的图片。
|
||||
|
||||
### Favicons
|
||||
### 网站图标(Favicons)
|
||||
|
||||
Favicons are located in `public/`, along with the other files you may want to upload to your website. I used this [website](https://www.favicon-generator.org/) to generate favicons.
|
||||
网站图标位于 `public/`,以及其他你可能想要上传至网站的文件。我使用这个[网站](https://www.favicon-generator.org/))生成了 favicons。
|
||||
|
||||
### Banner
|
||||
### 横幅(Banner)
|
||||
|
||||
You may also want to change the output of the `banner` command. To do that, simply paste your generated banner in `src/utils/bin/commands.ts`. I used this [website](https://manytools.org/hacker-tools/ascii-banner/) to generate my banner.
|
||||
你可能还想修改 `banner` 命令的输出。为此,只需将你生成的 banner 粘贴到 `src/utils/bin/commands.ts`。我使用这个[网站](https://manytools.org/hacker-tools/ascii-banner/))生成了我的 banner。
|
||||
|
||||
### Advanced Configuration
|
||||
### 高级配置
|
||||
|
||||
If you want to further customize your page, feel free to change the source code to your liking!
|
||||
如果你想进一步自定义页面,请随意按你的喜好修改源代码!
|
||||
|
||||
## 🌐 Deploy on Vercel
|
||||
## 🌐 在 Vercel 上部署
|
||||
|
||||
The easiest way to deploy a Next.js app is to use the [Vercel Platform](https://vercel.com/) from the creators of Next.js.
|
||||
部署 Next.js 应用最简单的方式是使用 Next.js 创建者提供的 [Vercel Platform](https://vercel.com/))。
|
||||
|
||||
You can install `vercel` cli and follow the instruction [here](https://vercel.com/docs/concepts/deployments/overview).
|
||||
你可以安装 `vercel` cli,并按照[这里](https://vercel.com/docs/concepts/deployments/overview).)的说明操作。
|
||||
|
||||
You can also connect your github account to vercel and have vercel automatically deploy the github repository for you.
|
||||
你也可以将 GitHub 账号连接到 Vercel,让 Vercel 自动为你部署 GitHub 仓库。
|
||||
|
||||
## Credit
|
||||
## 致谢
|
||||
|
||||
Based on M4TT72's awesome [Terminal](https://github.com/m4tt72/terminal).
|
||||
基于 M4TT72 出色的 [Terminal](https://github.com/m4tt72/terminal).
|
||||
|
||||
Reference in New Issue
Block a user