Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(docs): use friendly words #9

Merged
merged 9 commits into from
Jul 11, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion components/Icons/MoreFour.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ import { SVGProps } from "react";

export function IconParkMoreFour(props: SVGProps<SVGSVGElement>) {
return (
<svg xmlns="http://www.w3.org/2000/svg" width="1.5em" height="1.5em" viewBox="0 0 48 48" {...props}><mask id="ipTMoreFour0"><path fill="#555" stroke="#fff" strokeLinecap="round" strokeLinejoin="round" strokeWidth="4" d="m17 11l7.071-7.071L31.142 11l-7.07 7.071zm13 13l7.071-7.071L44.142 24l-7.07 7.071zM4 24l7.071-7.071L18.142 24l-7.07 7.071zm13 13l7.071-7.071L31.142 37l-7.07 7.071z"></path></mask><path fill="currentColor" d="M0 0h48v48H0z" mask="url(#ipTMoreFour0)"></path></svg>
<svg xmlns="http://www.w3.org/2000/svg" width="1.4em" height="1.4em" viewBox="0 0 48 48" {...props}><mask id="ipTMoreFour0"><path fill="#555" stroke="#fff" strokeLinecap="round" strokeLinejoin="round" strokeWidth="4" d="m17 11l7.071-7.071L31.142 11l-7.07 7.071zm13 13l7.071-7.071L44.142 24l-7.07 7.071zM4 24l7.071-7.071L18.142 24l-7.07 7.071zm13 13l7.071-7.071L31.142 37l-7.07 7.071z"></path></mask><path fill="currentColor" d="M0 0h48v48H0z" mask="url(#ipTMoreFour0)"></path></svg>
)
}
7 changes: 7 additions & 0 deletions components/Icons/PeopleCommunity.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { SVGProps } from "react";

export function FluentPeopleCommunity(props: SVGProps<SVGSVGElement>) {
return (
<svg xmlns="http://www.w3.org/2000/svg" width="1.5em" height="1.5em" viewBox="0 0 16 16" {...props}><path fill="currentColor" d="M3 3a2 2 0 1 1 4 0a2 2 0 0 1-4 0Zm2-1a1 1 0 1 0 0 2a1 1 0 0 0 0-2Zm4.779 2.584a2 2 0 1 1 2.442-3.168A2 2 0 0 1 9.78 4.584ZM11 2a1 1 0 1 0 0 2a1 1 0 0 0 0-2ZM2.5 6h2.67c-.11.313-.17.65-.17 1H2.5a.5.5 0 0 0-.5.5c0 .817.325 1.423.838 1.835c.236.19.519.343.839.455a2.5 2.5 0 0 0-.532.868a3.733 3.733 0 0 1-.933-.543C1.46 9.51 1 8.616 1 7.5A1.5 1.5 0 0 1 2.5 6Zm3.768 0a2 2 0 1 0 3.466 2a2 2 0 0 0-3.466-2Zm1.508.025A1.003 1.003 0 0 1 9 7a1 1 0 1 1-1.224-.975Zm5.386 3.31c-.236.19-.519.343-.839.455a2.5 2.5 0 0 1 .531.868c.34-.139.655-.32.934-.543C14.54 9.51 15 8.616 15 7.5A1.5 1.5 0 0 0 13.5 6h-2.67c.11.313.17.65.17 1h2.5a.5.5 0 0 1 .5.5c0 .817-.325 1.423-.838 1.835ZM10.5 10a1.5 1.5 0 0 1 1.5 1.5c0 1.116-.459 2.01-1.212 2.615C10.047 14.71 9.053 15 8 15c-1.053 0-2.047-.29-2.788-.885C4.46 13.51 4 12.616 4 11.5A1.496 1.496 0 0 1 5.5 10h5Zm0 1h-5a.5.5 0 0 0-.5.5c0 .817.325 1.423.838 1.835C6.364 13.757 7.12 14 8 14c.88 0 1.636-.243 2.162-.665c.513-.412.838-1.018.838-1.835a.5.5 0 0 0-.5-.5Z"></path></svg>
)
}
2 changes: 1 addition & 1 deletion pages/docs/community.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 社区用户 の 部署教程
# 社区部署教程

以下是社区用户分享的部署方式,你可以参考他们的部署方式,但我们不保证它们的可用性。如果你也有教程想要与大家分享的,欢迎您向文档提交 [Pull Request](https://github.com/mx-space/docs/pulls) 以分享您的部署方式。

Expand Down
11 changes: 10 additions & 1 deletion pages/docs/docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { Callout, Steps } from "nextra/components";
<Steps>
### 安装 Docker

如果你的服务器在国内,建议使用阿里云的镜像加速器,安装命令如下:
如果你的服务器在国内,建议使用阿里云的镜像加速,安装命令如下:

```bash
curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun
Expand All @@ -16,6 +16,15 @@ curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun
```bash
curl -fsSL https://get.docker.com | bash -s docker
```

均已经安装好 Docker 和 Docker-Compose,可以通过以下命令查看版本:
wibus-wee marked this conversation as resolved.
Show resolved Hide resolved

```bash
docker -v
docker compose -v
```


### 拉取配置文件

```bash
Expand Down
23 changes: 10 additions & 13 deletions pages/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,42 +6,39 @@ title: 引言

**Mix Space** 是一个一款简洁而不简单的个人博客系统,它够快,够现代。你可以利用它构建一个属于自己的个人空间,记录生活,分享知识。

在本章节,我们教你完成的是 **后端** 的安装,而 **前端** 的安装则需要你阅读 [前端主题文档](/themes)。
在本章节,我们你将完成的是 **后端** 的安装,而 **前端** 的安装则需要你阅读 [前端主题文档](/themes)。
wibus-wee marked this conversation as resolved.
Show resolved Hide resolved

<Callout type="info">
为什么分开部署?请查看本页 [一些你需要清楚知道的事情](#一些你需要清楚知道的事情) 小节。
为什么分开部署?请查看本页 [一些你需要知道的事情](#一些你需要知道的事情) 小节。
</Callout>

## 快速开始

<Callout type="warning">
如果你对 **Docker, Docker Compose, NodeJS, npm-script, git** 等技术不熟悉,建议先学习相关知识。文档中不会对这些技术进行详细介绍,且若由于不熟悉这些技术导致的问题,我们将**不会提供技术支持**。

如果你不是开发者,或者不想折腾,请不要选择**进阶部署**,因为它需要你具备一定的开发能力。
<Callout>
我们提供了三种部署方式,并且社区也提供了更多的部署方式,你可以根据自己的喜好选择一种部署方式。
</Callout>

import { Card, Cards, Callout } from 'nextra/components';
import { UimDocker } from '@components/Icons/Docker';
import { UilPaintTool } from '@components/Icons/PaintTool';
import { UimStar } from '@components/Icons/Star';
import { FluentPeopleCommunity } from '@components/Icons/PeopleCommunity';

<Cards num={3}>
<Cards num={2}>
<Card arrow title="Docker 部署 (推荐)" href="/docs/docker" icon={<UimDocker />} />
<Card arrow title="预设脚本部署" href="/docs/scripts" icon={<UilPaintTool />} />
<Card arrow title="进阶部署" href="/docs/advanced" icon={<UimStar />} />
<Card arrow title="社区部署教程" href="/docs/community" icon={<FluentPeopleCommunity />} />
</Cards>

还有更多部署方式吗?欢迎您向文档提交 [Pull Request](https://github.com/mx-space/docs/pulls) 以分享您的部署方式。按上方**后端部署文档**完成你的部署后,你可以通过继续部署 Mix Space **前端** *(为什么分开部署?请查看 [一些你需要清楚知道的事情](#一些你需要清楚知道的事情))*

下面是一些你可能需要的链接:
还有更多部署方式吗?欢迎您向文档提交 [Pull Request](https://github.com/mx-space/docs/pulls) 以分享您的部署方式。按上方**后端部署文档**完成你的部署后,你可以通过下面的方式继续部署 Mix Space **前端** *(为什么分开部署?请查看 [一些你需要知道的事情](#一些你需要知道的事情))*

<Cards num={1}>
<Card arrow title="前端主题 の 部署文档" href="/themes" />
<Card arrow title="社区用户 の 部署教程" href="/docs/community" />
<Card arrow title="浏览前端主题" href="/themes" />
</Cards>


## 一些你需要清楚知道的事情
## 一些你需要知道的事情

### 遇到报错怎么办?

Expand Down