+
+ 
+
+
+
+
+
+ [👗Read more](/en-us/themes/ ':class=a-button-cover')
+
+
+
+
+
+ 
- [👗浏览更多](./zh-cn/themes/readme.md ':class=a-button-cover')
+ [👗浏览更多](/zh-cn/themes/ ':class=a-button-cover')
@@ -86,9 +86,7 @@ ______
[源码地址](https://github.com/wonder-light/glidea)
-[讨论区]()
-
-[微博]()
+[讨论区](https://github.com/wonder-light/glidea/discussions/3)
[赞助]()
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
index f25439a..6c78ab6 100644
--- a/docs/_coverpage.md
+++ b/docs/_coverpage.md
@@ -9,6 +9,6 @@
> 可以方便的进行写作并将其部署到服务器上
[GitHub](https://github.com/wonder-light/glidea)
-[开 始](docs/)
+[开 始](zh-cn/docs/)
\ No newline at end of file
diff --git a/docs/assets/js/main.js b/docs/assets/js/main.js
index 4fc5c9b..03e265c 100644
--- a/docs/assets/js/main.js
+++ b/docs/assets/js/main.js
@@ -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,
@@ -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],
diff --git a/docs/en-us/README.md b/docs/en-us/README.md
index 63f8f00..16b1237 100644
--- a/docs/en-us/README.md
+++ b/docs/en-us/README.md
@@ -1 +1,93 @@
-# en-us
\ No newline at end of file
+# Why do you like Glidea
+
+Markdown
+ + Markdown is simple and fast. I like it + +Fast and secure
+ + All files are local, build static websites faster, no database to manage, and say goodbye to Wordpress + +Simple and extraordinary
+ + Set up a website in a few simple steps. Powerful customization, easy to navigate + +Open source cross-platform
+ + Glidea is released under this MIT license and will always remain free and open source + +Custom theme
+ + Choose or design unique interface themes according to your preferences and needs + +Easy to manage and build
+ + Easier content management and a simpler build process + +
+
+
+
+ {docsify-updated}
\ No newline at end of file diff --git a/docs/en-us/_coverpage.md b/docs/en-us/_coverpage.md new file mode 100644 index 0000000..e90e80a --- /dev/null +++ b/docs/en-us/_coverpage.md @@ -0,0 +1,14 @@ + + +
+
+# Glidea 1.0
+
+> 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/)
+
+
\ No newline at end of file
diff --git a/docs/en-us/_navbar.md b/docs/en-us/_navbar.md
new file mode 100644
index 0000000..0124436
--- /dev/null
+++ b/docs/en-us/_navbar.md
@@ -0,0 +1,8 @@
+
+
+* [Home](en-us/)
+* [Document](en-us/docs/)
+* [Theme](en-us/themes/)
+* Language
+ * [:cn: 简体中文](/)
+ * [:us: English](en-us/)
\ No newline at end of file
diff --git a/docs/en-us/_sidebar.md b/docs/en-us/_sidebar.md
new file mode 100644
index 0000000..e8d7141
--- /dev/null
+++ b/docs/en-us/_sidebar.md
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/en-us/docs/README.md b/docs/en-us/docs/README.md
new file mode 100644
index 0000000..a3f0283
--- /dev/null
+++ b/docs/en-us/docs/README.md
@@ -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 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
+
+
+
+
+## License :id=license
+
+[MIT](https://github.com/wonder-light/glidea/blob/main/LICENSE). Copyright (c) 2024 wonder-light
diff --git a/docs/en-us/docs/_sidebar.md b/docs/en-us/docs/_sidebar.md
new file mode 100644
index 0000000..173319e
--- /dev/null
+++ b/docs/en-us/docs/_sidebar.md
@@ -0,0 +1,16 @@
+
+
+* 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)
\ No newline at end of file
diff --git a/docs/en-us/docs/changelog.md b/docs/en-us/docs/changelog.md
new file mode 100644
index 0000000..238e274
--- /dev/null
+++ b/docs/en-us/docs/changelog.md
@@ -0,0 +1,4 @@
+
+# Change Log
+
+[filename](https://raw.githubusercontent.com/wonder-light/glidea/refs/heads/main/CHANGELOG-en.md ':include')
\ No newline at end of file
diff --git a/docs/en-us/docs/guide/faq.md b/docs/en-us/docs/guide/faq.md
new file mode 100644
index 0000000..b0730cc
--- /dev/null
+++ b/docs/en-us/docs/guide/faq.md
@@ -0,0 +1,3 @@
+# FAQ
+
+## 1
\ No newline at end of file
diff --git a/docs/en-us/docs/guide/install.md b/docs/en-us/docs/guide/install.md
new file mode 100644
index 0000000..d8ad939
--- /dev/null
+++ b/docs/en-us/docs/guide/install.md
@@ -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)
diff --git a/docs/en-us/docs/start/quick.md b/docs/en-us/docs/start/quick.md
new file mode 100644
index 0000000..710e37c
--- /dev/null
+++ b/docs/en-us/docs/start/quick.md
@@ -0,0 +1,51 @@
+
+
+# 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
+
+ 
+ 
+
+2.**Create a public repository for your built website files**
+
+ 
+
+3.**Go to Glidea for remote setup**
+
+ - Follow the example below to set up, and then click "Detect remote link" to check the configuration
+
+ 
+
+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
+
+{{ input('username') }}
+{{ input('password', type='password') }}
Share your theme with your friends on GitHub + +Click [here](https://github.com/wonder-light/glidea/discussions/3) to share to the discussion area\ +Click [here](https://github.com/new) to upload to the GitHub repository + +## Template :id=template + +The following templates are used to share themes: + +```markdown + + +[theme]:Glidea A static blog writing client
', + fileName: 'hello-glidea', + abstract: '', + description: 'A static blog writing client, welcome to Glidea', + title: 'Hello Glidea', + tags: [@tag, @tag, @tag], // Article tag array, specifically see the tag field below + date: 'December 12o 2018, am', + dateFormat: '2018-12-12', // Fields formatted according to Glidea in-app dates + feature: 'post-images/hello-glidea.png', // If there is no cover picture, it is '' + link: 'https://xxx.com/post/hello-glidea', + hideInList: false, // Takes effect only for articles with no label set + isTop: false, // Whether the top article + toc: '', // 文章目录字段 + prevPost: @post, // If it is the first article, this field is not available + nextPost: @post, // If it is the last article, this field is not available +} +``` + +### tag + +Tag field + +```js +tag: { + name: 'Glidea', + use: true, + count: 1, + slug: 'glidea', + link: 'https://xxx.com/tag/glidea', +} +``` + +### themeConfig + +Theme configuration field + +```js +themeConfig: { + selectTheme: "tech", + domain: "https://github.com", + archivesPageSize: 50, + archivesPath: "archives", // Archive page path prefix, which can be customized within the application, such as 'blog', 'news', etc + dateFormat: "yyyy-MM-dd", + feedCount: 10, + useFeed: false, + footerInfo: "Powered by Glidea", + postPageSize: 12, + postPath: "post", + postUrlFormat: "slug", + showFeatureImage: true, + siteDescription: "Every 🐦 has an 🦅's dream.", + siteName: "hey", + tagPath: "tag", + tagUrlFormat: "shortId", + generateSiteMap: true, + robotsText: "", +} +``` + +### site + +Site field + +```js +site: { + posts: @posts, + tags: @tags, + menus: @menus, + themeConfig: @themeConfig, + isHomepage: false, // Whether it is the home page, it is rendered using index.j2, and it is true when it is the first page + customConfig: {}, // Topic Custom configuration field, if none {} + utils: { + now: "1577006772710", // Date.now() + }, +}; +``` + +### commentSetting + +Comment setting + +```js +commentSetting: { + commentPlatform: 'disqus', + disqusSetting: { + api: '', + apikey: 'Dme6Hy8bOI2xxxxUtdY8V', + shortname: 'glidea', + }, + gitalkSetting: { + clientId: 'd92dxxxxxxxxxx9b4', + clientSecret: '861947exxxx365d33', + owner: 'EryouHao', + repository: 'EryouHao.github.io' + }, + showComment: false // Whether to display comments. You can display comments according to this field +} +``` + + +## Other :id=other + +### Avatar :id=avatar + +```html +
+```
+
+### Web icon :id=favicon
+
+```html
+
+```
+
+### Style file :id=main.css
+
+```html
+
+```
diff --git a/docs/en-us/themes/README.md b/docs/en-us/themes/README.md
new file mode 100644
index 0000000..64851c3
--- /dev/null
+++ b/docs/en-us/themes/README.md
@@ -0,0 +1,5 @@
+# Theme
+
+Gridea 一个静态博客写作客户端
\n👏 欢迎使用 Gridea ！
\n🌈 Gridea 一个静态博客写作客户端。你可以用它来记录你的生活、心情、知识、笔记、创意... ...
', - fileName: 'hello-gridea', - abstract: 'Gridea 一个静态博客写作客户端
\n', - description: '一个静态博客写作客户端 欢迎使用 Gridea！Gridea 一个静态博客写作客户端。你可以用它来记录你的生...', // 智能截取文章开始内容填充此字段，可用作未设置摘要时备用字段 - title: 'Hello Gridea', + content: 'Glidea 一个静态博客写作客户端
', + fileName: 'hello-glidea', + abstract: '', + description: '一个静态博客写作客户端 欢迎使用 Glidea', // 智能截取文章开始内容填充此字段，可用作未设置摘要时备用字段 + title: 'Hello Glidea', tags: [@tag, @tag, @tag], // 文章 tag 数组，具体可见下面 tag 字段 date: 'December 12o 2018, am', - dateFormat: '2018-12-12', // 依据 Gridea 应用内日期格式化后字段 - feature: 'post-images/hello-gridea.png', // 若无封面图，则为'' - link: 'https://xxx.com/post/hello-gridea', + dateFormat: '2018-12-12', // 依据 Glidea 应用内日期格式化后字段 + feature: 'post-images/hello-glidea.png', // 若无封面图，则为'' + link: 'https://xxx.com/post/hello-glidea', hideInList: false, // 仅对未设置标签文章生效 isTop: false, // 是否是置顶文章 toc: '', // 文章目录字段 @@ -157,11 +157,11 @@ post: { ```js tag: { - name: 'Gridea', + name: 'Glidea', use: true, count: 1, - slug: 'gridea', - link: 'https://xxx.com/tag/gridea', + slug: 'glidea', + link: 'https://xxx.com/tag/glidea', } ``` @@ -178,7 +178,7 @@ themeConfig: { dateFormat: "yyyy-MM-dd", feedCount: 10, useFeed: false, - footerInfo: "Powered by Gridea", + footerInfo: "Powered by Glidea", postPageSize: 12, postPath: "post", postUrlFormat: "slug", @@ -202,7 +202,7 @@ site: { tags: @tags, menus: @menus, themeConfig: @themeConfig, - isHomepage: false, // 是否为首页，使用 index.ejs 渲染，且为第一页的时候为 true + isHomepage: false, // 是否为首页，使用 index.j2 渲染，且为第一页的时候为 true customConfig: {}, // 主题自定义配置字段，若无则为 {} utils: { now: "1577006772710", // Date.now() @@ -220,7 +220,7 @@ commentSetting: { disqusSetting: { api: '', apikey: 'Dme6Hy8bOI2xxxxUtdY8V', - shortname: 'gridea', + shortname: 'glidea', }, gitalkSetting: { clientId: 'd92dxxxxxxxxxx9b4',