From 61297eb37013b1d68018a09fc405b462415ebeed Mon Sep 17 00:00:00 2001 From: Daniel <845765@qq.com> Date: Wed, 15 May 2024 10:26:51 +0800 Subject: [PATCH] :memo: Update README --- README.md | 44 +++++++++++++++++++++++++++++++++++++++----- README_zh_CN.md | 48 +++++++++++++++++++++++++++++++++++++++++------- 2 files changed, 80 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 76f83e5b6..2c098c140 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@

Twitter Follow +Chat on Discord

SiYuan - A privacy-first personal knowledge management software | Product Hunt

@@ -27,6 +28,39 @@ 中文

+--- + +## Table of Contents + +* [💡 Introduction](#-introduction) +* [🔮 Features](#-features) +* [🏗️ Architecture design and open source ecosystem](#️-architecture-design-and-open-source-ecosystem) +* [🌟 Star History](#-star-history) +* [🗺️ Roadmap](#️-roadmap) +* [🚀 Download Setup](#-download-setup) + * [App Market](#app-market) + * [Installation Package](#installation-package) + * [Docker Hosting](#docker-hosting) + * [Unraid Hosting](#unraid-hosting) + * [Insider Preview](#insider-preview) +* [🏘️ Community](#️-community) +* [🛠️ Development Guide](#️-development-guide) +* [❓ FAQ](#-faq) + * [How does SiYuan store data?](#how-does-siyuan-store-data) + * [Does it support data synchronization through a third-party sync disk?](#does-it-support-data-synchronization-through-a-third-party-sync-disk) + * [Is SiYuan open source?](#is-siyuan-open-source) + * [How to upgrade to a new version?](#how-to-upgrade-to-a-new-version) + * [Is there any note for deleting docs?](#is-there-any-note-for-deleting-docs) + * [How can I just wrap and not start a new paragraph?](#how-can-i-just-wrap-and-not-start-a-new-paragraph) + * [What if some blocks (such as paragraph blocks in list items) cannot find the block icon?](#what-if-some-blocks-such-as-paragraph-blocks-in-list-items-cannot-find-the-block-icon) + * [How to share notes?](#how-to-share-notes) + * [What should I do if the data repo key is lost?](#what-should-i-do-if-the-data-repo-key-is-lost) + * [Do I need to pay for it?](#do-i-need-to-pay-for-it) +* [🙏 Acknowledgement](#-acknowledgement) + * [Contributors](#contributors) + +--- + ## 💡 Introduction SiYuan is a privacy-first personal knowledge management system, support fine-grained block-level reference and Markdown @@ -116,6 +150,11 @@ Desktop: * [Microsoft Store](https://apps.microsoft.com/detail/9p7hpmxp73k4) +### Installation Package + +* [B3log](https://b3log.org/siyuan/en/download.html) +* [GitHub](https://github.com/siyuan-note/siyuan/releases) + ### Docker Hosting
@@ -223,11 +262,6 @@ Publish parameters: --workspace=/siyuan/workspace/ --accessAuthCode=******(Acces
-### Installation Package - -* [B3log](https://b3log.org/siyuan/en/download.html) -* [GitHub](https://github.com/siyuan-note/siyuan/releases) - ### Insider Preview We release insider preview before major updates, please visit [https://github.com/siyuan-note/insider](https://github.com/siyuan-note/insider). diff --git a/README_zh_CN.md b/README_zh_CN.md index 6bc742589..e22232a17 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -19,6 +19,7 @@

Twitter Follow +Chat on Discord

SiYuan - A privacy-first personal knowledge management software | Product Hunt

@@ -27,6 +28,39 @@ English

+--- + +## 目录 + +* [💡 简介](#-简介) +* [🔮 特性](#-特性) +* [🏗️ 架构设计和开源生态](#️-架构设计和开源生态) +* [🌟 星标历史](#-星标历史) +* [🗺️ 路线图](#️-路线图) +* [🚀 下载安装](#-下载安装) + * [应用市场](#应用市场) + * [安装包](#安装包) + * [Docker 部署](#docker-部署) + * [Unraid 部署](#unraid-部署) + * [内部预览版](#内部预览版) +* [🏘️ 社区](#️-社区) +* [🛠️ 开发指南](#️-开发指南) +* [❓ 常见问题和解答](#-常见问题和解答) + * [思源是如何存储数据的？](#思源是如何存储数据的) + * [支持通过第三方同步盘进行数据同步吗？](#支持通过第三方同步盘进行数据同步吗) + * [思源是开源的吗？](#思源是开源的吗) + * [如何升级到新版本？](#如何升级到新版本) + * [删除文档有什么注意事项吗？](#删除文档有什么注意事项吗) + * [如何才能只换行不新起段落？](#如何才能只换行不新起段落) + * [有的块（比如在列表项中的段落块）找不到块标怎么办？](#有的块比如在列表项中的段落块找不到块标怎么办) + * [如何分享笔记？](#如何分享笔记) + * [数据仓库密钥遗失怎么办？](#数据仓库密钥遗失怎么办) + * [使用需要付费吗？](#使用需要付费吗) +* [🙏 鸣谢](#-鸣谢) + * [贡献者列表](#贡献者列表) + +--- + ## 💡 简介 思源笔记是一款隐私优先的个人知识管理系统，支持细粒度块级引用和 Markdown 所见即所得。 @@ -91,7 +125,7 @@ | [ios](https://github.com/siyuan-note/siyuan-ios) | iOS App | ![GitHub forks](https://img.shields.io/github/forks/siyuan-note/siyuan-ios) | ![GitHub Repo stars](https://img.shields.io/github/stars/siyuan-note/siyuan-ios) | | [riff](https://github.com/siyuan-note/riff) | 间隔重复 | ![GitHub forks](https://img.shields.io/github/forks/siyuan-note/riff) | ![GitHub Repo stars](https://img.shields.io/github/stars/siyuan-note/riff) | -## 🌟 Star History +## 🌟 星标历史 [![Star History Chart](https://api.star-history.com/svg?repos=siyuan-note/siyuan&type=Date)](https://star-history.com/#siyuan-note/siyuan&Date) @@ -119,6 +153,11 @@ * [Microsoft Store](https://apps.microsoft.com/detail/9p7hpmxp73k4) +### 安装包 + +* [B3log](https://b3log.org/siyuan/download.html) +* [GitHub](https://github.com/siyuan-note/siyuan/releases) + ### Docker 部署
@@ -226,11 +265,6 @@ Publish parameters: --workspace=/siyuan/workspace/ --accessAuthCode=******（访
-### 安装包 - -* [B3log](https://b3log.org/siyuan/download.html) -* [GitHub](https://github.com/siyuan-note/siyuan/releases) - ### 内部预览版 我们会在有重大更新前发布内部预览版，请访问 [https://github.com/siyuan-note/insider](https://github.com/siyuan-note/insider)。 @@ -301,7 +335,7 @@ Publish parameters: --workspace=/siyuan/workspace/ --accessAuthCode=******（访 请使用 Shift+Enter。 -## 有的块（比如在列表项中的段落块）找不到块标怎么办？ +### 有的块（比如在列表项中的段落块）找不到块标怎么办？ 在列表项下的第一个子块是省略块标的。可以将光标移到这个块中，然后通过 Ctrl+/ 触发它的块标菜单。