Skip to content

Commit 0c47637

Browse files
committed
update docs
1 parent 9b370a6 commit 0c47637

14 files changed

Lines changed: 66 additions & 74 deletions

File tree

docs/astro.config.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ export default defineConfig({
9393
items: [
9494
{ label: '下载快捷指令', translations: { en: 'Download Shortcuts' }, slug: 'shortcuts/downloads' },
9595
{ label: '填写配置', translations: { en: 'Fill in Configuration' }, slug: 'shortcuts/configuration' },
96-
{ label: '建立同步文件夹', translations: { en: 'Create Sync Folder' }, slug: 'shortcuts/sync-folder' },
96+
{ label: '同步、删除与备份', translations: { en: 'Sync, Delete & Backup' }, slug: 'shortcuts/sync-folder' },
9797
{ label: '自动化', translations: { en: 'Automation' }, slug: 'shortcuts/automation' },
9898
],
9999
},
579 KB
Loading

docs/src/content/docs/customization/site-config.mdx

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,7 @@ export default {
3434
pageSize: 10,
3535

3636
// 主题选择
37-
theme: "receipt",
38-
39-
// 你所在的时区
40-
utcOffset: 8
41-
37+
theme: "receipt"
4238
}
4339
```
4440

@@ -88,17 +84,10 @@ export default {
8884
### theme
8985

9086
**类型**`string`
91-
**可选值**`"receipt"` | `"cyberpunk"` | `"academic"` | `"pixel"`
87+
**可选值**`"classic"` | `"receipt"` | `"cyberpunk"` | `"academic"` | `"pixel"` | `"bento"`
9288

9389
主题风格,详见[主题风格](/customization/themes/)章节。
9490

95-
### utcOffset
96-
97-
**类型**`number`
98-
**默认值**`8`
99-
100-
你所在的 UTC 时区,用于计算文章的发布时间。
101-
10291
## 示例配置
10392

10493
一个完整的配置示例:
@@ -109,9 +98,7 @@ export default {
10998
author: "Aeris",
11099
description: "记录技术、生活与思考",
111100
pageSize: 8,
112-
theme: "academic",
113-
avatar: "https://avatars.githubusercontent.com/u/123456",
114-
utcOffset: 8
101+
theme: "academic"
115102
}
116103
```
117104

docs/src/content/docs/customization/themes.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ Moire 提供多套精心设计的主题,每个主题都有独特的视觉风
99

1010
## 可用主题
1111

12+
### Classic(默认)
13+
14+
![](./classic.png)
15+
1216
### Receipt(票据风)
1317

1418
**特点**

docs/src/content/docs/en/customization/site-config.mdx

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,7 @@ export default {
3333
pageSize: 10,
3434

3535
// Theme selection
36-
theme: "receipt",
37-
38-
// Your time zone
39-
utcOffset: 8
40-
36+
theme: "receipt"
4137
}
4238
```
4339

@@ -87,16 +83,10 @@ The number of posts displayed per page on the home page.
8783
### theme
8884

8985
**Type**: `string`
90-
**Options**: `"receipt"` | `"cyberpunk"` | `"academic"` | `"pixel"`
86+
**Options**: `"classic"` | `"receipt"` | `"cyberpunk"` | `"academic"` | `"pixel"` | `"bento"`
9187

9288
The theme style. See the [Themes](/en/customization/themes/) chapter for details.
9389

94-
### utcOffset
95-
96-
**Type**: `number`
97-
**Default**: `8`
98-
99-
Your UTC time zone offset, used to calculate post publication times.
10090

10191
## Example Configuration
10292

@@ -108,9 +98,7 @@ export default {
10898
author: "Aeris",
10999
description: "Notes on technology, life, and thoughts",
110100
pageSize: 8,
111-
theme: "academic",
112-
avatar: "https://avatars.githubusercontent.com/u/123456",
113-
utcOffset: 8
101+
theme: "academic"
114102
}
115103
```
116104

docs/src/content/docs/en/customization/themes.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ Moire offers several meticulously designed themes, each with its own unique visu
99

1010
## Available Themes
1111

12+
### Classic (Default)
13+
14+
![](../../customization/classic.png)
15+
16+
1217
### Receipt (Retro Style)
1318

1419
**Features**:

docs/src/content/docs/en/shortcuts/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Once configured, we need to create a dedicated folder in Apple Notes.
8383
import { LinkCard } from '@astrojs/starlight/components';
8484

8585
<LinkCard
86-
title="Create Sync Folder"
87-
description="Create the Moire folder in Apple Notes"
86+
title="Sync, Delete & Backup"
87+
description="Create the Moire folder in Apple Notes, sync, delete and backup"
8888
href="/en/shortcuts/sync-folder/"
8989
/>

docs/src/content/docs/en/shortcuts/sync-folder.mdx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,13 @@ If you deleted the note from Apple Notes before adding the `[DEL]` tag, you can:
112112

113113
If you only want to use Moire to sync and back up your notes without making them public as a blog, follow these steps:
114114

115-
1. **Disable GitHub Pages**: In your GitHub repository's Settings > Pages, set the "Source" under Build and deployment to "None", or remove the deployment workflow.
116-
2. **Set Repository to Private**: In Settings > General > Danger Zone, change the repository's visibility to **Private**.
115+
### **Disable GitHub Pages**
116+
117+
In your GitHub repository's Settings > Pages, set the "Source" under Build and deployment to "None", or remove the deployment workflow.
118+
119+
### **Set Repository to Private**
120+
121+
In Settings > General > Danger Zone, change the repository's visibility to **Private**.
117122

118123
Since the GitHub Access Token you configured in the Shortcut has permission to access private repositories, the sync functionality will still work perfectly, but your notes will only be visible to you.
119124

docs/src/content/docs/en/usage/images.mdx

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,6 @@ import { Steps } from '@astrojs/starlight/components';
66

77
Moire supports inserting images into notes, but there are some important limitations to ensure stability.
88

9-
## Key Limitations
10-
11-
:::danger[Supports only 1 image per sync]
12-
Whenever the Moire Sync Shortcut runs, it will only upload the **first** image found in the note.
13-
14-
This is to ensure the speed and stability of the Shortcut.
15-
:::
16-
17-
:::caution[Image Deletion Note]
18-
Currently, Moire does not handle the deletion of images automatically.
19-
20-
To prevent the GitHub repository from growing excessively, please be cautious when replacing or deleting images in your posts. If you remove an image link from your note, the previously uploaded image file in `/src/memos/images/` will still remain in the repository.
21-
:::
22-
239

2410
## How It Works
2511

@@ -32,6 +18,19 @@ When you insert an image in Apple Notes and sync:
3218
4. Automatically inserts the image link into the Markdown file
3319
</Steps>
3420

21+
## Important Limitations
22+
23+
### 1. Supports only 1 image per sync
24+
Whenever the Moire Sync Shortcut runs, it will only upload the **first** image found in the note.
25+
26+
This is to ensure the speed and stability of the Shortcut.
27+
28+
### 2. No automatic image deletion
29+
Currently, Moire does not handle the deletion of images automatically.
30+
31+
To prevent the GitHub repository from growing excessively, please be cautious when replacing or deleting images in your posts. If you remove an image link from your note, the previously uploaded image file in `/src/memos/images/` will still remain in the repository.
32+
33+
3534
## Recommendations
3635

3736
### ✅ Do:

docs/src/content/docs/shortcuts/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ moire
8383
import { LinkCard } from '@astrojs/starlight/components';
8484

8585
<LinkCard
86-
title="建立同步文件夹"
87-
description="在备忘录中创建 Moire 文件夹"
86+
title="同步、删除与备份"
87+
description="在备忘录中创建 Moire 文件夹,同步、删除与备份"
8888
href="/shortcuts/sync-folder/"
8989
/>

0 commit comments

Comments
 (0)