Skip to content

Commit

Permalink
[udpate] README 更新
Browse files Browse the repository at this point in the history
  • Loading branch information
qingfengzxr committed Dec 3, 2023
1 parent 0137029 commit f9cc213
Showing 1 changed file with 18 additions and 19 deletions.
37 changes: 18 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# The OP Stack Docs
# OP Stack中文文档

[![Discord](https://img.shields.io/discord/667044843901681675.svg?color=768AD4&label=discord&logo=https%3A%2F%2Fdiscordapp.com%2Fassets%2F8c9701b98ad4372b58f13fd9f65f966e.svg)](https://discord.gg/optimism)
[![Twitter Follow](https://img.shields.io/twitter/follow/optimismPBC.svg?label=optimismPBC&style=social)](https://twitter.com/optimismPBC)
Expand All @@ -7,38 +7,37 @@ OP Stack是一个开放的、集体维护的区块链生态系统开发堆栈。

> 本仓库中文文档由LXDAO翻译,目前已翻译部分关键的入门文档,剩余的翻译工作仍在持续推进中。
## Development

### Serving docs locally
## 开发

### 本地启动
```sh
yarn dev
```

Then navigate to [http://localhost:8080](http://localhost:8080).
If that link doesn't work, double check the output of `yarn dev`.
You might already be serving something on port 8080 and the site may be on another port (e.g., 8081).
然后在浏览器中访问 [http://localhost:8080](http://localhost:8080)
如果链接无法打开,请仔细检查 `yarn dev` 的输出。
您可能已经在8080端口上运行了其他服务,网站可能在其他端口上(例如8081)。

### Building docs for production
### 构建生产环境的文档

```sh
yarn build
```

You probably don't need to run this command, but now you know.
您可能不需要运行此命令,但现在您已经知道了。

### Editing docs
### 编辑文档

Edit the markdown directly in [src/docs](./src/docs).
直接在[src/docs](./src/docs)中编辑Markdown文件。

### Adding new docs
### 添加新文档

Add your markdown files to [src/docs](./src/docs).
You will also have to update [src/.vuepress/config.js](./src/.vuepress/config.js) if you want these docs to show up in the sidebar.
将您的Markdown文件添加到[src/docs](./src/docs)中。
如果您希望这些文档显示在侧边栏中,还需要更新[src/.vuepress/config.js](./src/.vuepress/config.js)

### Updating the theme
### 更新主题

We currently use an ejected version of [vuepress-theme-hope](https://vuepress-theme-hope.github.io/).
Since the version we use was ejected from the original theme, you'll see a bunch of compiled JavaScript files instead of the original TypeScript files.
There's not much we can do about that right now, so you'll just need to make do and edit the raw JS if you need to make theme adjustments.
We're planning to move away from VuePress relatively soon anyway so we won't be fixing this.
目前使用的是从[VuePress主题](https://vuepress-theme-hope.github.io/)中分离出来的版本。
由于我们使用的版本是从原始主题中分离出来的,所以您将看到一堆编译后的JavaScript文件,而不是原始的TypeScript文件。
目前我们无法解决这个问题,所以如果您需要进行主题调整,您只能编辑原始的JS文件。
我们计划在不久的将来转向其他文档生成工具,所以我们不会修复这个问题。

0 comments on commit f9cc213

Please sign in to comment.