docs: migrate readme and zh readme

quanru · Mar 14, 2024 · 8451962 · 8451962
1 parent 10a5468
commit 8451962
Show file tree

Hide file tree

Showing 7 changed files with 59 additions and 229 deletions.
diff --git a/README-ZH.md b/README-ZH.md
@@ -0,0 +1,51 @@
+# Obsidian LifeOS
+
+> 曾用名：Obsidian Periodic PARA
+
+<p align="center">中文版本 | <a title="English" href="https://github.com/quanru/obsidian-periodic-para">English Version</a></p>
+
+<a href="https://www.producthunt.com/posts/lifeos-template-for-obsidian?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-lifeos&#0045;template&#0045;for&#0045;obsidian" target="_blank">
+ <img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=441390&theme=light" alt="LifeOS&#0032;Template&#0032;for&#0032;Obsidian - Obsidian&#0032;LifeOS&#0032;&#0045;&#0032;Your&#0032;Life&#0032;Management&#0032;Assistant&#0033; | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" />
+</a>
+
+- 这是一个专为 [LifeOS](https://quanru.github.io/2023/06/18/%E4%B8%80%E7%A7%8D%E5%AE%9E%E7%94%A8%E6%96%B0%E5%9E%8B%20Obsidian%20%E5%AE%9E%E8%B7%B5%E4%B9%8B%E6%9E%84%E5%BB%BA%E6%88%91%E7%9A%84%E7%AC%AC%E4%BA%8C%E5%A4%A7%E8%84%91%20%F0%9F%A7%A0/) 开发的 Obsidian 插件，可通过『周期笔记』和『[usememos](https://www.usememos.com/)』来实践 PARA 方法。
+- 强烈推荐下载 [LifeOS-example](https://github.com/quanru/obsidian-example-LifeOS/tree/chinese-version) 示例仓库来体验本插件。
+- 更多教程，请访问[Obsidian LifeOS 官网](https://obsidian-life-os.netlify.app/zh)查看
+
+## 特性
+
+请前往官方网站：https://obsidian-life-os.netlify.app/zh/plugin/life-os
+
+## 用户支持
+
+- [Twitter](https://twitter.com/quanruzhuoxiu)
+- [Discord](https://discord.gg/HZGanKEkuZ)
+- [Lark](https://applink.feishu.cn/client/chat/chatter/add_by_link?link_token=ba8p19af-4cdf-4c94-8a59-95cea664ea61)
+- [Email](mailto:quanruzhuoxiu@gmail.com)
+
+## 致谢
+
+此外，我还借鉴了以下优秀插件的代码：
+
+- [PARA](https://fortelabs.com/blog/para/)。感谢 Tiago Forte 发明了如此出色的 PARA 组织法。
+- [obsidian-periodic-notes](https://github.com/liamcain/obsidian-periodic-notes)。这个插件给了我开发本插件的灵感。
+- [obsidian-dataview](https://github.com/blacksmithgu/obsidian-dataview)。底层插件使用了 dataview 的查询接口。
+- [Templater](https://github.com/SilentVoid13/Templater)。提供了解耦的模板创建，让很多插件能够利用它来创建文件。
+
+## 捐赠
+
+如果这个插件对您有帮助，请在[buymeacoffee](https://www.buymeacoffee.com/leyang)上给我买杯咖啡。
+
+<a href="https://www.buymeacoffee.com/leyang"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=leyang&button_colour=40DCA5&font_colour=ffffff&font_family=Cookie&outline_colour=000000&coffee_colour=FFDD00" /></a>
+
+---
+
+或者支付宝
+
+<img alt="Alipay" src="https://quanru.github.io/img/alipay-qr.jpg" width="200"/>
+
+---
+
+或者微信
+
+<img alt="WeChatPay" src="https://quanru.github.io/img/wechat-qr.jpg" width="200"/>
diff --git a/README.md b/README.md
@@ -2,244 +2,19 @@
 
 > Previously Used Name: Obsidian Periodic PARA
 
+<p align="center"><a title="中文版本" href="https://github.com/quanru/obsidian-periodic-para/blob/main/ZH-README.md">中文版本</a> | English Version</p>
+
 <a href="https://www.producthunt.com/posts/lifeos-template-for-obsidian?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-lifeos&#0045;template&#0045;for&#0045;obsidian" target="_blank">
  <img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=441390&theme=light" alt="LifeOS&#0032;Template&#0032;for&#0032;Obsidian - Obsidian&#0032;LifeOS&#0032;&#0045;&#0032;Your&#0032;Life&#0032;Management&#0032;Assistant&#0033; | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" />
 </a>
 
-- This is a plugin for [LifeOS](https://forum.obsidian.md/t/building-my-second-brain-with-obsidian/62934), which assist in practicing the PARA method with periodic notes and usememos.
+- This is a plugin for [LifeOS](https://quanru.github.io/2023/07/08/Building%20my%20second%20brain%20%F0%9F%A7%A0%20with%20Obsidian/), which assist in practicing the PARA method with periodic notes and [usememos](https://www.usememos.com/).
 - It is recommended to download the [LifeOS-example](https://github.com/quanru/obsidian-example-LifeOS/tree/main) to experience it.
 - For more tutorials, please go to [LifeOS for Obsidian Official Site](https://obsidian-life-os.netlify.app/)
 
 ## Features
 
-### Periodic Notes
-
-![](assets/periodic-para-plugin.png)
-
-### Combine Periodic Notes with PARA Notes
-
-![](assets/periodic-para-plugin-en.png)
-
-### Create Periodic Notes & PARA Notes Visually
-
-> See [Youtube Demo](https://www.youtube.com/watch?v=poey9QoB7ns)
-
-It is recommended to work with [Templater](https://silentvoid13.github.io/Templater/) so that you can use the template variables and functions provided by [Templater](https://silentvoid13.github.io/Templater/).
-
-![](assets/periodic-para-plugin-add-1-en.png)
-![](assets/periodic-para-plugin-add-2-en.png)
-
-### Daily Record(Capture daily inspiration quickly)
-
-> [usememos](https://github.com/usememos/memos)
-
-#### Manner 1: Through Memos Web App
-
-- https://github.com/quanru/obsidian-periodic-para/assets/11739753/b2dfbe07-869c-4b08-93a8-85c289755a71
-
-#### Manner 2: Through [MoeMemos App](https://memos.moe/)
-
-- https://github.com/quanru/obsidian-periodic-para/assets/11739753/a5c24a84-1a5f-48b5-9aeb-06f95c283e78
-
-#### Manner 3: Through [iOS Shortcut](https://www.icloud.com/shortcuts/1eaef307112843ed9f91d256f5ee7ad9)
-
-- https://github.com/quanru/obsidian-periodic-para/assets/11739753/3d967527-b021-4a15-acd4-f5e6b0701a99
-
-## Installation
-
-> [Dataview](https://github.com/blacksmithgu/obsidian-dataview) is required, please install it first.
-
-#### Recommended
-
-Periodic PARA is available in the Obsidian community plugin browser!
-
-1. Search for "Periodic PARA" in Obsidian's community plugins browser
-2. Enable the plugin in your Obsidian settings (find "Periodic PARA" under "Community plugins").
-3. Check the settings. You can customize the directory of periodic notes and PARA notes.
-
-#### Manual
-
-Go to the [releases](https://github.com/quanru/obsidian-periodic-para/releases) and download the latest `main.js` and `manifest.json` files. Create a folder called `periodic-para` inside `.obsidian/plugins` and place both files in it.
-
-## Settings
-
-| Periodic Notes Settings | Description |
-| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| Enable | Whether to turn on Periodic Notes |
-| Periodic Notes Folder | Default is 'PeriodicNotes', Set a folder for periodic notes. The format of daily, weekly, monthly, quarterly, and yearly notes in the directory must meet the following requirements: YYYY-MM-DD、YYYY-Www、YYYY-MM、YYYY-Qq |
-| Project List Header | Default is 'Project List', Set the title of the module in which the project snapshots are located in daily notes to collect the projects experienced in the current period in the weekly, monthly, quarterly, and yearly notes |
-| Area List Header | Default is 'First Things Dimension', Set the title of the module in which the area snapshots are located in quarterly notes to collect the areas experienced in the current period in the yearly notes |
-| Habit List Header | Default is 'Habit', Set the title of the module in daily notes where the habit is located, and the task query view will ignore tasks under that title |
-
-| Daily Record Settings | Description |
-| --------------------- | ----------------------------------------------------------------------------------- |
-| Enable | Sync daily record by remote [usememos](https://github.com/usememos/memos) API |
-| Header | Where the Daily Record module is in a daily note |
-| API | The daily record API, usememos server + API(https://your-use-memos.com/api/v1/memo) |
-| Token | The token of your API, find token in https://your-use-memos.com/setting |
-
-| P.A.R.A Notes Settings | Description |
-| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Enable | Whether to turn on PARA Notes |
-| Projects Folder | Default is '1. Projects', Set a folder where the PARA project is located, each subdirectory is a project, and each project must have a [XXX.]README.md or a file with the same name as the folder as the project index |
-| Areas Folder | Default is '2. Areas', Set a folder where the PARA area is located, each subdirectory is a area, and each area must have a [XXX.]README.md or a file with the same name as the folder as the area index |
-| Resources Folder | Default is '3. Resources', Set a folder where the PARA resource is located, each subdirectory is a resource, and each resource must have a [XXX.]README.md or a file with the same name as the folder as the resource index |
-| Archives Folder | Default is '4. Archives', Set a folder where the PARA archive is located, each subdirectory is a archive, and each archive must have a [XXX.]README.md or a file with the same name as the folder as the archive index |
-
-## Usage
-
-### daily record
-
-> [usememos](https://github.com/usememos/memos)
-
-Integration with [usememos](https://github.com/usememos/memos), you need to deploy your own usememos.
-
-Or use the [demo](https://demo.usememos.com/auth/signup) to experience.
-
-### query code block
-
-Periodic PARA works by writing markdown code block, which query project, area, task list according to the date parsed from current filename, and query task, bullet, project, area, resource, archive list according to the tags parsed from frontmatter.
-
-#### query by time
-
-Time scope is parsed from current file name, for example:
-
-- 2023-01-01.md // Only 1 January is included
-- 2023-W21.md // Every day of week 21
-- 2023-06.md // Every day and every week of June
-- 2023-Q3.md // Every day, every week, every month of Quarter 3
-- 2023.md // Every day, every week, every month, every quarter of 2023
-
-````markdown
-```PeriodicPARA
-TaskDoneListByTime
-```
-````
-
-````markdown
-```PeriodicPARA
-TaskRecordListByTime
-```
-````
-
-````markdown
-```PeriodicPARA
-ProjectListByTime
-```
-````
-
-````markdown
-```PeriodicPARA
-AreaListByTime
-```
-````
-
-#### query by tag
-
-Tags is parsed from the [Properties](https://help.obsidian.md/Editing+and+formatting/Properties) of current file, for example:
-
-```markdown
----
-tags:
- - x-project
----
-```
-
-The following code block would use x-project as the tag for the query.
-
-````markdown
-```PeriodicPARA
-TaskListByTag
-```
-````
-
-````markdown
-```PeriodicPARA
-BulletListByTag
-```
-````
-
-````markdown
-```PeriodicPARA
-FileListByTag
-```
-````
-
-````markdown
-```PeriodicPARA
-ProjectListByTag
-```
-````
-
-````markdown
-```PeriodicPARA
-AreaListByTag
-```
-````
-
-````markdown
-```PeriodicPARA
-ResourceListByTag
-```
-````
-
-````markdown
-```PeriodicPARA
-ArchiveListByTag
-```
-````
-
-#### query para by folder
-
-````markdown
-```PeriodicPARA
-ProjectListByFolder
-```
-````
-
-````markdown
-```PeriodicPARA
-AreaListByFolder
-```
-````
-
-````markdown
-```PeriodicPARA
-ResourceListByFolder
-```
-````
-
-````markdown
-```PeriodicPARA
-ArchiveListByFolder
-```
-````
-
-### [templater](https://github.com/SilentVoid13/Templater) helpers
-
-#### Generate list
-
-Generate a list of README.md snapshots in the specified directory.
-
-```markdown
-<% PeriodicPARA.Project.snapshot() %>
-<% PeriodicPARA.Area.snapshot() %>
-<% PeriodicPARA.Resource.snapshot() %>
-<% PeriodicPARA.Archive.snapshot() %>
-```
-
-For example:
-
-```markdown
-<% PeriodicPARA.Project.snapshot() %>
-```
-
-to
-
-```markdown
-1. [[1. Projects/x-project/README|x-project]]
-2. [[1. Projects/y-project/README|y-project]]
-```
+Please visit the official doc: https://obsidian-life-os.netlify.app/plugin/life-os
 
 ## Support
 
@@ -265,8 +40,12 @@ If this plugin do help you, please buy me a cup of coffee on [buymeacoffee](http
 
 ---
 
+Or Alipay
+
 <img alt="Alipay" src="https://quanru.github.io/img/alipay-qr.jpg" width="200"/>
 
 ---
 
+Or WeChat
+
 <img alt="WeChatPay" src="https://quanru.github.io/img/wechat-qr.jpg" width="200"/>
diff --git a/assets/periodic-para-plugin-add-1-en.png b/assets/periodic-para-plugin-add-1-en.png
diff --git a/assets/periodic-para-plugin-add-2-en.png b/assets/periodic-para-plugin-add-2-en.png
diff --git a/assets/periodic-para-plugin-en.png b/assets/periodic-para-plugin-en.png
diff --git a/assets/periodic-para-plugin.png b/assets/periodic-para-plugin.png
diff --git a/assets/templater-config.png b/assets/templater-config.png