Skip to content

Commit 7418caf

Browse files
committed
docs: updated docs
1 parent e143e8b commit 7418caf

8 files changed

Lines changed: 78 additions & 8 deletions

File tree

docs/pages/en/plugins/markdown-it-bi-directional-links/Internal Page.md renamed to docs/pages/en/plugins/markdown-it-bi-directional-links/Bi-directional Links Example Page.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# Internal Page
1+
# Bi-directional Links Example Page
22

33
Hi! This is a linked internal page.

docs/pages/en/plugins/markdown-it-bi-directional-links/Same Name Page.md renamed to docs/pages/en/plugins/markdown-it-bi-directional-links/Bi-directional Links Example Same Name Page.md

File renamed without changes.

docs/pages/en/plugins/markdown-it-bi-directional-links/index.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,32 @@
22

33
## Usage
44

5-
```markdown
6-
[[Some Item]]
5+
Install `@nolebase/markdown-it-bi-directional-links` to your project dependencies by running the following command:
6+
7+
::: code-group
8+
9+
```shell [pnpm]
10+
pnpm add @nolebase/markdown-it-bi-directional-links
11+
```
12+
13+
```shell [npm]
14+
npm install @nolebase/markdown-it-bi-directional-links
15+
```
16+
17+
```shell [yarn]
18+
yarn add @nolebase/markdown-it-bi-directional-links
719
```
820

21+
:::
22+
23+
24+
925
## Example
1026

11-
[[Internal Page]]
27+
```markdown
28+
[[Target Page File Name]]
29+
```
30+
31+
## Demo
32+
33+
[[Bi-directional Links Example Page]]

docs/pages/en/plugins/markdown-it-bi-directional-links/same-name/Same Name Page.md renamed to docs/pages/en/plugins/markdown-it-bi-directional-links/same-name/Bi-directional Links Example Same Name Page.md

File renamed without changes.

docs/pages/zh-CN/plugins/markdown-it-bi-directional-links/index.md

Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,58 @@
22

33
## 如何使用
44

5+
通过下面的命令将 `@nolebase/markdown-it-bi-directional-links` 安装到你的项目依赖中:
6+
7+
::: code-group
8+
9+
```shell [pnpm]
10+
pnpm add @nolebase/markdown-it-bi-directional-links
11+
```
12+
13+
```shell [npm]
14+
npm install @nolebase/markdown-it-bi-directional-links
15+
```
16+
17+
```shell [yarn]
18+
yarn add @nolebase/markdown-it-bi-directional-links
19+
```
20+
21+
:::
22+
23+
然后先在 [`markdown-it`](https://github.com/markdown-it/markdown-it) 的实例可被访问的地方先使用 `import` 语句将双向链接插件导入到文件中:
24+
25+
```typescript
26+
import MarkdownItBiDirectionalLinks from '@nolebase/markdown-it-bi-directional-links' // [!code ++]
27+
```
28+
29+
然后使用 `markdown-it` 实例的 `use()` 函数将导入后的 `MarkdownItBiDirectionalLinks` 作为插件使用:
30+
31+
```typescript
32+
import MarkdownItBiDirectionalLinks from '@nolebase/markdown-it-bi-directional-links'
33+
34+
// 中间剩余的其他代码...
35+
36+
markdownIt.use(MarkdownItBiDirectionalLinks()) // [!code ++]
37+
```
38+
39+
`MarkdownItBiDirectionalLinks()` 函数中,你需要提供一个必填的选项对象,该对象中的 `dir` 字段通常可以直接通过 `import` 语句导入 `process` 或者 `node:process` 之后的 `cwd()` 函数来获取:
40+
41+
```typescript
42+
import MarkdownItBiDirectionalLinks from '@nolebase/markdown-it-bi-directional-links'
43+
44+
// 中间剩余的其他代码...
45+
46+
markdownIt.use(MarkdownItBiDirectionalLinks({
47+
dir: process.cwd() // [!code ++]
48+
}))
49+
```
50+
51+
## 用法示例
52+
553
```markdown
6-
[[Some Item]]
54+
[[双向链接目标页面的文件名称]]
755
```
856

9-
## 示例
57+
## 效果演示
1058

11-
[[内部页面]]
59+
[[双向链接示例页面]]

docs/pages/zh-CN/plugins/markdown-it-bi-directional-links/Same Name Page.md renamed to docs/pages/zh-CN/plugins/markdown-it-bi-directional-links/same-name/双向链接示例同名页面.md

File renamed without changes.

docs/pages/zh-CN/plugins/markdown-it-bi-directional-links/same-name/Same Name Page.md renamed to docs/pages/zh-CN/plugins/markdown-it-bi-directional-links/双向链接示例同名页面.md

File renamed without changes.

docs/pages/zh-CN/plugins/markdown-it-bi-directional-links/内部页面.md renamed to docs/pages/zh-CN/plugins/markdown-it-bi-directional-links/双向链接示例页面.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# 内部页面
1+
# 双向链接示例页面
22

33
嗨!这是一个内部页面。

0 commit comments

Comments
 (0)