Skip to content

Commit

Permalink
zh-cn/docs: 添加快速开始页面
Browse files Browse the repository at this point in the history
  • Loading branch information
wonder-light committed Dec 31, 2024
1 parent c266f84 commit c38bd21
Show file tree
Hide file tree
Showing 10 changed files with 92 additions and 24 deletions.
22 changes: 11 additions & 11 deletions docs/READEME.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,47 +2,47 @@

<div align="center">

<br>
<br/>

![markdown](./assets/images/markdown.svg ':class=img-normal')

<p class="p-big">Markdown</p>

知道你钟爱 Markdown 写作,我们也是

<br>
<br/>

![safe](./assets/images/safe.svg ':class=img-normal')

<p class="p-big">快且安全</p>

所有文件都在本地,更快的构建静态网站,无需管理数据库,向 Wordpress 说拜拜

<br>
<br/>

![simple](./assets/images/simple.svg ':class=img-normal')

<p class="p-big">简而不凡</p>

简单几步即可搭建网站。强大的自定义能力,轻松驾驭

<br>
<br/>

![open-source](./assets/images/open-source.svg ':class=img-normal')

<p class="p-big">开源跨平台</p>

Glidea 基于此 MIT 许可发布, 并将始终保持免费和开源

<br>
<br/>

![themes](./assets/images/themes.svg ':class=img-normal')

<p class="p-big">自定义主题</p>

根据自己的喜好和需求,选择或设计独特的界面主题

<br>
<br/>

![manager](./assets/images/manager.svg ':class=img-normal')

Expand All @@ -52,23 +52,23 @@

</div>

<br>
<br>
<br/>
<br/>

# 主题

<div align="center">

<br>
<br/>

![theme-1](./assets/images/background_14.jpg ':class=img-theme')

[👗浏览更多](./zh-cn/themes/readme.md ':class=a-button-cover')

</div>

<br>
<br>
<br/>
<br/>

# 客户端下载

Expand Down
Binary file added docs/assets/images/quick-access-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/quick-github-sync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/quick-new-github-repo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/quick-new-token.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 6 additions & 11 deletions docs/zh-cn/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@

# Glidea
# Glidea :id=glidea

> 一个静态博客写作客户端
<br>

# 概述
## 概述 :id=general

Glidea 可以帮助你更容易地构建并管理博客或任何静态站点, 你可以用它来记录你的生活、心情、知识、笔记、创意等等

查看[快速开始](zh-cn/docs/start/quick.md)了解详情

<br>

# 特性👇
## 特性👇 :id=features

- 📝 你可以使用简洁的 **Markdown** 语法,进行快速创作

Expand All @@ -37,22 +35,19 @@ Glidea 可以帮助你更容易地构建并管理博客或任何静态站点,

- 🖥 你可以自定义源文件夹,利用 OneDrive、百度网盘等进行多设备同步

<br>

# 开发
## 开发 :id=development

如果你想贡献代码,请提前参阅[贡献指南](https://github.com/wonder-light/glidea/wiki/%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)

<br>

# 捐赠
## 捐赠 :id=donate

如果你觉得 glidea 对你有帮助,或者想对我微小的工作一点资瓷,欢迎给我捐赠

![donate](../../assets/images/reward_qrcode.png ':size=280')

<br>

# License
## License :id=license

[MIT](https://github.com/wonder-light/glidea/blob/main/LICENSE). Copyright (c) 2024 wonder-light
2 changes: 2 additions & 0 deletions docs/zh-cn/docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,7 @@
* [变量](zh-cn/docs/theme/var.md)
* [自定义](zh-cn/docs/theme/custom.md)
* 指南
* [安装](zh-cn/docs/guide/install.md)
* [常见问题](zh-cn/docs/guide/faq.md)
* [功能](zh-cn/docs/guide/ability.md)
* [Changelog](zh-cn/docs/changelog.md)
9 changes: 9 additions & 0 deletions docs/zh-cn/docs/guide/ability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

# 功能

<br/>

- 文章
- [ ] 根据选择的主题来渲染 markdown, 并将起呈现在 preview
- 渲染
- [ ] 使用 dart 来渲染模板文件
18 changes: 18 additions & 0 deletions docs/zh-cn/docs/guide/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

# 安装客户端 :id=install

<!-- [install] -->

[windows](https://github.com/wonder-light/glidea/releases/windows ':class=a-button')

[linux](https://github.com/wonder-light/glidea/releases/linux ':class=a-button')

[macos](https://github.com/wonder-light/glidea/releases/macos ':class=a-button')

[android](https://github.com/wonder-light/glidea/releases/android ':class=a-button')

[ios](https://github.com/wonder-light/glidea/releases/ios ':class=a-button')

当前版本: v1.0.0 [✨ What's new?](https://github.com/wonder-light/glidea/releases)

<!-- [install] -->
48 changes: 46 additions & 2 deletions docs/zh-cn/docs/start/quick.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,49 @@
<!-- quick.md -->

# 快速开始
# 快速开始 :id=start

# 看看
> 你好,欢迎开始愉快的 Gridea 之旅呀~

## 安装 :id=install

- 安装 [Glidea](zh-cn/docs/guide/install.md)


## 写作 :id=write

相信你自己可以搞得定哦,加油写作啦!


## 发布 :id=publish

?> Glidea 提供了将博客部署到 GitHub Pages、Coding Pages 和通过 SFTP 的方式上传到自己的服务器的功能。下面将以 GitHub 为例,来讲一下部署流程

1.**创建 GitHub 账号,并创建一个仓库 Token**

- 点击 [Github](https://github.com/),进行注册
- 登录 GitHub 之后,点击[这里](https://github.com/settings/tokens/new)创建一个 Token,**勾选上 repo 的相关权限即可**
- 生成之后记得把 Token 复制到你的本地,因为一旦关闭网页将不能再看到它

![token](../../../assets/images/quick-new-token.jpg)
![access](../../../assets/images/quick-access-token.png)

2.**创建公开仓库,存放构建后的网站文件**

![new-repo](../../../assets/images/quick-new-github-repo.jpg)

3.**进入 Glidea 进行远程设置**

- 按照下图的示例进行设置,然后点击「检测远程链接」,进行配置检查

![sync](../../../assets/images/quick-github-sync.png)

4.**同步**

- 点击 Gridea 中的 同步按钮即可。初次部署等待几分钟之后就可以去浏览器访问了,默认地址为你在第 3 步所填写的域名

<br/>

以上,就完成一个静态博客的搭建了,期待你的每一次落笔成文

🥰

0 comments on commit c38bd21

Please sign in to comment.