Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pull] master from cyanzhong:master #32

Open
wants to merge 37 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
f51b6ba
Add guidance for using search
cyanzhong Apr 10, 2022
ac49305
Release Notes is now What's New
cyanzhong Apr 11, 2022
5e1fe26
Refreshed keyboard shortcuts
cyanzhong Apr 13, 2022
eb1832f
Open Quickly
cyanzhong Apr 13, 2022
419f7ce
Performance tips for external files
cyanzhong Apr 13, 2022
c288c98
Search & Replace is now supported
cyanzhong Apr 17, 2022
9e280d9
Don't use mono-spaced font for ⌘ ⇧ O
cyanzhong Apr 17, 2022
26719b8
Update what's new page
cyanzhong Apr 17, 2022
d8e2852
Improve dark mode for images
cyanzhong Apr 17, 2022
442da24
Update what's new page
cyanzhong May 1, 2022
4563c17
Replace with regex groups
cyanzhong May 7, 2022
2b19495
Add missing screenshot
cyanzhong May 8, 2022
5f1fdba
Update what's new page
cyanzhong May 16, 2022
b0b5205
New scheme to prepend text
cyanzhong May 18, 2022
2c968a7
Docs for command palette
cyanzhong Jun 5, 2022
8d58fc7
Obviously macOS app was released a long time ago
cyanzhong Jun 6, 2022
e4c6bcd
New keyboard shortcuts for command palette
cyanzhong Jun 11, 2022
3e23884
Add missing emoji in what's new
cyanzhong Jun 13, 2022
dd98ceb
New keyboard shortcut to finish editing
cyanzhong Jul 9, 2022
da2fb06
Improve URL schemes for opening files to support start editing
cyanzhong Jul 17, 2022
bb46b43
New URL scheme to start search in the app
cyanzhong Jul 17, 2022
4226e55
Add PlantUML support
cyanzhong Jul 28, 2022
aa9ae2d
Update what's new page
cyanzhong Jul 28, 2022
a613d51
Improved file creation workflow
cyanzhong Jul 31, 2022
5f58aad
Add explanation for wiki links
cyanzhong Aug 6, 2022
7010aef
Update what's new page
cyanzhong Aug 8, 2022
eae49bb
Update what's new page
cyanzhong Aug 15, 2022
f05f9ef
Update what's new page
cyanzhong Sep 8, 2022
9a4a549
Unlink dev.taio.app
cyanzhong Sep 12, 2022
4e535fe
Update what's new page
cyanzhong Sep 18, 2022
5754709
Add basic AppleScript to work with Hook
cyanzhong Sep 24, 2022
5f92e96
New docs for customizable previews
cyanzhong Oct 8, 2022
6a50898
Better explanation for color remixing
cyanzhong Oct 10, 2022
754dbb4
Quick switcher for iPadOS 16
cyanzhong Oct 10, 2022
b0e1534
Writing styles
cyanzhong Oct 12, 2022
c68b727
What's new for Live Activity and Dynamic Island
cyanzhong Oct 30, 2022
d3eccb8
Expose URL scheme for Live Notes
cyanzhong Nov 1, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add explanation for wiki links
  • Loading branch information
cyanzhong committed Aug 6, 2022
commit 5f58aad053675d46a34fb78825b29c179bb1625c
1 change: 1 addition & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
- [File Creation](editor/file-creation.md)
- [Tags](editor/tags.md)
- [Search](editor/search.md)
- [Wiki Links](editor/wiki-links.md)
- [Math Formulas](editor/math.md)
- [Diagrams](editor/diagrams.md)
- [Image Uploading](editor/image-uploading.md)
Expand Down
1 change: 1 addition & 0 deletions docs/cn/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
- [创建文件](cn/editor/file-creation.md)
- [标签](cn/editor/tags.md)
- [搜索](cn/editor/search.md)
- [Wiki 链接](cn/editor/wiki-links.md)
- [数学公式](cn/editor/math.md)
- [绘制图表](cn/editor/diagrams.md)
- [图片上传](cn/editor/image-uploading.md)
Expand Down
33 changes: 33 additions & 0 deletions docs/cn/editor/wiki-links.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## Wiki 链接

除了像 `[Title](link)` 这样原生支持的 Markdown 链接外,Taio 还内置了对 `[[文件名]]` 这样 wiki 链接的支持。

> 它是用来链接内部文件的,而不是引用一个远程资源,如网页。

## 文件定位

Wiki 链接可以是相对路径或绝对路径。

当使用绝对路径时,例如 `[[目录名/文件名]]`,它直接指向 `./目录名/文件名.md`(或 .txt,取决于是否存在)。

当使用相对路径时,例如 `[[文件名]]`,它会递归地搜索整个目录,并使用最佳的匹配结果。

## 文件锚点

我们也可以在链接中指定一个锚点,如 `[[文件名#标题]]`。

当我们打开文件时,它会自动滚动到标题。

## 显示标题

默认情况下,生成的 HTML 中的链接使用文件名作为其显示标题。

如果我们偏好提供一个明确的显示标题,就像我们在 Markdown 链接中可以做到的一样,语法是 `[[文件名|显示标题]]`。

## 内嵌文件

类似于 Markdown 语法中我们用 `![](link)` 来内嵌图片,我们也可以用 wiki 链接来内嵌文件,只需在链接前加一个 `!`(感叹号)即可:`![[Image.png]]`。

> 支持常用的图片格式,如 `png`、`jpg`、`gif` 等。

对于 Markdown 文件或纯文本文件,也可以用这种语法内嵌。例如,`![[文件名]]` 会将其内容嵌入到当前文件中,可以被直接预览。
33 changes: 33 additions & 0 deletions docs/editor/wiki-links.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## Wiki Links

In addition to Markdown links supported natively like `[Title](link)`, Taio also has built-in support for wiki links like `[[File Name]]`.

> It is used to link an internal document, rather than referring to a remote resource, like webpage.

## File Locating

A wiki link can be either relative path or absolute path.

When an absolute path is used, such as `[[Folder Name/File Name]]`, it points directly to `./Folder Name/File Name.md` (or .txt depends on the existence).

When a relative path is used, such as `[[File Name]]`, it searches the entire folder recursively and uses the best match.

## File Anchor

We can also specify an anchor in the link, like `[[File Name#Heading]]`.

When we open the file, it scrolls to the heading automatically.

## Display Title

By default, the link in generated HTML uses the file name as its display title.

If we prefer to provide an explicit display title, like we can in Markdown links, the syntax is `[[File Name|Display Title]]`.

## Embedding Files

Similar to Markdown syntax, where we use `![](link)` to embed an image, we can also embed files with wiki links, simply put a `!` (exclamation mark) before the link: `![[Image.png]]`.

> Commonly used image formats are all supported, such as `png`, `jpg`, `gif`, etc.

For Markdown files or plain text files, they can also be embedded using this syntax. For instance, `![[File Name]]` would embed its content into the current file, and it can be inline previewed.