Skip to content

Commit

Permalink
modified: README.md
Browse files Browse the repository at this point in the history
	modified:   README_zh_CN.md
  • Loading branch information
mustakshif committed Jan 2, 2024
1 parent c46ce93 commit 8da0e4a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 6 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ An ultra-modern macOS-like theme for [SiYuan Note](https://github.com/siyuan-not
* **Tab bar (not toolbar/top bar)**
* **Breadcrumb**
* **Sidebar panel title and above**
* 📌 If you need the top bar pinned, please go to `Settings - Appearance - Code Snippet`, then add and enable this code line under `JS` tab: `document.body.classList.add("hadeeth-pin-toolbar");`. To hide the top bar again, you need to disable this snippet and reload the page or restart the app.
* ↕️ Applied system scrollbar on macOS, which can be hidden automatically and reduce visual interference.

* 📌 If your system scroll bar setting is **not** set to `When scrolling` in: `System Settings - Appearance - Show scroll bars` on macOS, scroll bars in SiYuan’s dark mode will be displayed as in light mode, which still needs to be fixed.
Expand All @@ -35,7 +34,24 @@ An ultra-modern macOS-like theme for [SiYuan Note](https://github.com/siyuan-not
* 🚀 High level of performance maintained.
* ...


> ### 🔧 About Custom Configuration
>
> For some theme features that may affect user experience, you can customize whether they are disabled using code snippets.
>
> Go to `Settings - Appearance - Code Snippet` in SiYuan and, in the `JS` tab, chose from the following code snippets as needed and then add to your list and enable them:
>
> ```js
> // Use pinned top bar
> document.body.classList.add("hadeeth-pin-toolbar");
>
> // Disable glassmorphism
> document.body.classList.add("hadeeth-disable-backdrop-blur");
>
> // Use SiYuan's default scrollbar (macOS only)
> document.body.classList.add("hadeeth-use-webkit-scrollbar");
> ```
>
> To restore the default theme configuration, you need to disable the code snippets you used and reload app window or restart the app.
## How to use
Expand Down
5 changes: 1 addition & 4 deletions README_zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Hadeeth 是一款极富现代感的类 macOS [思源笔记](https://github.com/s
* **页签栏(不是顶栏)**
* **面包屑**
* **侧栏面板标题及上部**
* ❗️ 如需顶栏常驻,请前往 `设置 - 外观 - 代码片段`,在 `JS` 选项卡下添加这段代码并启用:`document.body.classList.add("hadeeth-pin-toolbar");`。重新隐藏顶栏需要关闭这段代码并重新载入页面或重启应用。
* ↕️ 修改 Mac 端滚动条为系统样式,可自动隐藏,减少视觉干扰

* ❗️ 如果系统设置中**没有**`外观 - 显示滚动条` 设为 `滚动时`,暗色模式下仍会显示浅色模式的滚动条,这个 bug 尚待修复
Expand All @@ -39,11 +38,9 @@ Hadeeth 是一款极富现代感的类 macOS [思源笔记](https://github.com/s

> ### 🔧 关于自定义主题配置
>
> ---
>
> 对于部分可能影响使用体验的主题特性,可以通过代码片段自定义是否启用。
>
> 前往 `设置 - 外观 - 代码片段`,在 `JS` 选项卡下,按需选择添加以下代码并启用
> 前往 `设置 - 外观 - 代码片段`,在 `JS` 选项卡下,按需选取以下代码添加并启用
>
> ```js
> // 常驻顶栏
Expand Down

0 comments on commit 8da0e4a

Please sign in to comment.