Skip to content

Commit

Permalink
docs: 添加 en-us 文档
Browse files Browse the repository at this point in the history
  • Loading branch information
wonder-light committed Jan 4, 2025
1 parent 669b94a commit d7043b7
Show file tree
Hide file tree
Showing 28 changed files with 1,198 additions and 98 deletions.
5 changes: 1 addition & 4 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,9 @@ assignees: ''

对这个新功能的一段描述



## 动机

为什么你希望在 Gridea 中使用这个功能?

为什么你希望在 Glidea 中使用这个功能?


## 详细解释
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Question
about: Gridea 有任何问题吗?
about: Glidea 有任何问题吗?
title: ''
labels: 'question'
assignees: ''
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

👏 欢迎使用 **Glidea**

🔔 **Glidea** 是对 [Gridea](https://github.com/getGlidea/Glidea) 的 flutter 实现, 完全免费开源
🔔 **Glidea** 是对 [Gridea](https://github.com/getGlidea/Gridea) 的 flutter 实现, 完全免费开源

✍️ **Glidea** 一个静态博客写作客户端, 可以用来记录你的生活、心情、想法... ...

Expand Down
6 changes: 2 additions & 4 deletions docs/READEME.md → docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<img class="img-theme" src="./assets/images/background_14.jpg" alt="theme-1"/>
</div>

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

</div>

Expand All @@ -86,9 +86,7 @@ ______

[源码地址](https://github.com/wonder-light/glidea)

[讨论区]()

[微博]()
[讨论区](https://github.com/wonder-light/glidea/discussions/3)

[赞助]()

Expand Down
2 changes: 1 addition & 1 deletion docs/_coverpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@
> 可以方便的进行写作并将其部署到服务器上
[GitHub](https://github.com/wonder-light/glidea)
[开 始](docs/)
[开 始](zh-cn/docs/)

![coverpage](../assets/images/R-C.jpg)
7 changes: 5 additions & 2 deletions docs/assets/js/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,10 @@ window.$docsify = {
// 禁用相对路径
relativePath: false,
basePath: "/",
homepage: "READEME.md",
homepage: "README.md",
notFoundPage: "not-found.md",
// 切换页面后是否自动跳转到页面顶部
auto2top: true,
loadNavbar: true,
// 小屏设备下合并导航栏到侧边栏
mergeNavbar: false,
Expand All @@ -131,7 +133,8 @@ window.$docsify = {
routerMode: "history",
formatUpdated: "{YYYY}/{MM}/{DD} {HH}:{mm}:{ss}",
alias: {
"/.*/_navbar.md": "/_navbar.md",
"/zh-cn/.*/_navbar.md": "/_navbar.md",
"/en-us/.*/_navbar.md": "/en-us/_navbar.md",
"/([a-z]*-[a-z]*)/docs/.*/_sidebar.md": "/$1/docs/_sidebar.md",
},
plugins: [hideEmptySidebar],
Expand Down
94 changes: 93 additions & 1 deletion docs/en-us/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,93 @@
# en-us
# Why do you like Glidea <!-- {docsify-ignore-all} -->

<div align="center">

<br/>

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

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

Markdown is simple and fast. I like it

<br/>

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

<p class="p-big">Fast and secure</p>

All files are local, build static websites faster, no database to manage, and say goodbye to Wordpress

<br/>

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

<p class="p-big">Simple and extraordinary</p>

Set up a website in a few simple steps. Powerful customization, easy to navigate

<br/>

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

<p class="p-big">Open source cross-platform</p>

Glidea is released under this MIT license and will always remain free and open source

<br/>

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

<p class="p-big">Custom theme</p>

Choose or design unique interface themes according to your preferences and needs

<br/>

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

<p class="p-big">Easy to manage and build</p>

Easier content management and a simpler build process

</div>

<br/>
<br/>

# Themes

<div align="center">

<br/>
<div class="img-theme-list">
<img class="img-theme" src="../assets/images/background_14.jpg" alt="theme-1"/>
<img class="img-theme" src="../assets/images/background_14.jpg" alt="theme-1"/>
<img class="img-theme" src="../assets/images/background_14.jpg" alt="theme-1"/>
<img class="img-theme" src="../assets/images/background_14.jpg" alt="theme-1"/>
</div>

[👗Read more](/en-us/themes/ ':class=a-button-cover')

</div>

<br/>
<br/>

# Client download

[install](../commont/install.md ':include')

Current version: v1.0.0 [✨ What's new?](https://github.com/wonder-light/glidea/releases)

______

### Other

[Source address](https://github.com/wonder-light/glidea)

[Discussion address](https://github.com/wonder-light/glidea/discussions/3)

[Sponsor]()

<p>{docsify-updated}</p>
14 changes: 14 additions & 0 deletions docs/en-us/_coverpage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!-- _coverpage.md -->

<img src="../assets/images/logo.png" width="80px" height="80px" alt="logo">

# Glidea <small>1.0</small>

> An artifact of static blog writing client,
>
> It can be easily written and deployed to the server
[GitHub](https://github.com/wonder-light/glidea)
[Start](en-us/docs/)

![coverpage](../assets/images/R-C.jpg)
8 changes: 8 additions & 0 deletions docs/en-us/_navbar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!-- _navbar.md -->

* [Home](en-us/)
* [Document](en-us/docs/)
* [Theme](en-us/themes/)
* Language
* [:cn: 简体中文](/)
* [:us: English](en-us/)
1 change: 1 addition & 0 deletions docs/en-us/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!-- _sidebar.md -->
54 changes: 54 additions & 0 deletions docs/en-us/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@

# Glidea :id=glidea

> A static blog writing client

## Summarize :id=general

Glidea makes it easier to build and manage a blog or any static site that
you can use to record your life, mood, knowledge, notes, ideas, and more

Check out [Quick Start](en-us/docs/start/quick.md) for details


## Features👇 :id=features

- 📝 You can use the concise **Markdown** syntax to create quickly

- 🌉 You can give the article with a beautiful cover image and insert the image anywhere in the article

- 🏷️ You can group articles by tags

- 📋 You can customize the menu, you can create an external link menu

- 💻 You can use this client on a desktop or mobile device

- 🌎 You can use **𝖦𝗂𝗍𝗁𝗎𝖻 𝖯𝖺𝗀𝖾𝗌** or **Coding Pages** to show the world, the future will support more platform

<!--
- 💬 You can do simple configuration, access (Gitalk)(https://github.com/gitalk/gitalk) or (DisqusJS)(https://github.com/SukkaW/DisqusJS) comment system
-->

- 🗺️ You can use **Chinese Simplified**, **English** and so on

- 🌁 You can use the default theme or any third party theme, has a strong theme customization ability

- 🖥 You can customize the source folder, using OneDrive, Baidu web disk and other multi-device synchronization


## Development :id=development

If you want to contribute code, please refer to the [Contribution Guidelines](https://github.com/wonder-light/glidea/wiki/%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97) in advance.


## Donate :id=donate

If you find Glidea helpful, or would like to contribute to my little work, please donate to me

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


## License :id=license

[MIT](https://github.com/wonder-light/glidea/blob/main/LICENSE). Copyright (c) 2024 wonder-light
16 changes: 16 additions & 0 deletions docs/en-us/docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!-- _sidebar.md -->

* Introduction
* [Intro](en-us/docs/)
* [Quick start](en-us/docs/start/quick.md)
* Theme
* [Develop](en-us/docs/theme/dev.md)
* [Structure](en-us/docs/theme/struct.md)
* [Variable](en-us/docs/theme/var.md)
* [Custom](en-us/docs/theme/custom.md)
* [Share](en-us/docs/theme/shared.md)
* Guide
* [Install](en-us/docs/guide/install.md)
* [FAQ](en-us/docs/guide/faq.md)
* [Feature](zh-cn/docs/guide/ability.md)
* [Changelog](en-us/docs/changelog.md)
4 changes: 4 additions & 0 deletions docs/en-us/docs/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

# Change Log

[filename](https://raw.githubusercontent.com/wonder-light/glidea/refs/heads/main/CHANGELOG-en.md ':include')
3 changes: 3 additions & 0 deletions docs/en-us/docs/guide/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# FAQ

## 1
5 changes: 5 additions & 0 deletions docs/en-us/docs/guide/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Installing the client

[install](../../../commont/install.md ':include')

Current version: v1.0.0 [✨ What's new?](https://github.com/wonder-light/glidea/releases)
51 changes: 51 additions & 0 deletions docs/en-us/docs/start/quick.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<!-- quick.md -->

# Quick start :id=start

> Hello, welcome to start a pleasant trip to Glidea~

## Install :id=install

- Install [Glidea](en-us/docs/guide/install.md)


## Writing :id=write

Believe that you can do it yourself, come on, write!


## Publish :id=publish

?> Glidea provides the ability to deploy blogs to GitHub Pages, Coding Pages, and upload to your own server via SFTP. \
Let's take GitHub as an example to explain the deployment process

1.**Create a GitHub account and create a warehouse Token**

- Click on [GitHub](https://github.com/) to sign up
- Login after making, click [here](https://github.com/settings/tokens/new) to create a Token,**select repo permissions**
- Remember to copy the **Token** to your local site after it is generated, as the web page will no longer be able to see it once closed

![token](../../../assets/images/quick-new-token.jpg ':class=img-cover')
![access](../../../assets/images/quick-access-token.png ':class=img-cover')

2.**Create a public repository for your built website files**

![new-repo](../../../assets/images/quick-new-github-repo.jpg ':class=img-cover')

3.**Go to Glidea for remote setup**

- Follow the example below to set up, and then click "Detect remote link" to check the configuration

![sync](../../../assets/images/quick-github-sync.png ':class=img-cover')

4.**Synchronization**

- Click the sync button in Glidea. Wait a few minutes for the initial deployment and you will be able to access it in your browser.\
The default address will be the domain name you filled in in step 3

<br/>

Above, to complete the construction of a static blog, looking forward to your every written

🥰
Loading

0 comments on commit d7043b7

Please sign in to comment.