Skip to content

Commit

Permalink
docs(extension): 💬 rearrange
Browse files Browse the repository at this point in the history
  • Loading branch information
@Interstellar750
Interstellar750 committed Mar 4, 2023
1 parent c324562 commit 143286f
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 66 deletions.
45 changes: 23 additions & 22 deletions advanced/extension.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,67 +4,68 @@ It is people like you who bring extension plugins to this project, and the follo

## Article Components

### Profile Card
### Alert

#### Made by [藍+85CD](https://github.com/kwaa) | Demo - [./kwaa.dev](https://kwaa.dev/about#关于我)
#### Made by [藍+85CD](https://github.com/kwaa) | Demo - [Seviche.cc](https://seviche.cc/2022-12-20-pleroma-mod/)

<details>
<summary>Configuration</summary>

**⚠ This extension is not yet included in Urara, you need to download the component manually.**

Download the [**profile.svelte**](https://github.com/importantimport/urara-docs/raw/master/public/extension/profile/profile.svelte) file and put it in the `src/lib/components/extra/` directory.
**✅ This extension is included in Urara, no additional download is needed.**

#### Components to be imported before use:

```md
<script lang="ts">
import Profile from '$lib/components/extra/profile.svelte'
<script>
import Alert from '$lib/components/extra/alert.svelte'
</script>
```

#### Usage:

```md
<Profile subname="Here is the last name."/>
<Alert status="warning" description="warning message" title="warning title"/>
```

This extension will display a profile card within your post, where the avatar, name and profile will follow your settings in `site.ts`, and you can also specify them manually via `avatar="<image path>"`, `name="name"` and ``bio={`bio`}``.

```md
<Profile name="name" avatar="/assets/maskable@512.png" subname="Here is the last name." bio={`Here is the bio <br>This is the second line of the bio.`} />
```
You can modify the status of the prompt as needed. The available options are: `info`, `success`, `warning` and `error`.

You can also refer to the use case source code: [**blog/+page.svelte.md at main · kwaa/blog**](https://github.com/kwaa/blog/blob/main/urara/about/+page.svelte.md?plain=1#L13).
You can also refer to the use case source code: [**Urara-Blog/+page.svelte.md at main · Sevichecc/Urara-Blog**](https://github.com/Sevichecc/Urara-Blog/blob/main/urara/2022-12-20-pleroma-mod/+page.svelte.md?plain=1#L12).

</details>

### Alert

#### Made by [藍+85CD](https://github.com/kwaa) | Demo - [Seviche.cc](https://seviche.cc/2022-12-20-pleroma-mod/)
### Profile Card

#### Made by [藍+85CD](https://github.com/kwaa) | Demo - [./kwaa.dev](https://kwaa.dev/about#关于我)

<details>
<summary>Configuration</summary>

**✅ This extension is included in Urara, no additional download is needed.**
**⚠ This extension is not yet included in Urara, you need to download the component manually.**

Download the [**profile.svelte**](https://github.com/importantimport/urara-docs/raw/master/public/extension/profile/profile.svelte) file and put it in the `src/lib/components/extra/` directory.

#### Components to be imported before use:

```md
<script>
import Alert from '$lib/components/extra/alert.svelte'
<script lang="ts">
import Profile from '$lib/components/extra/profile.svelte'
</script>
```

#### Usage:

```md
<Alert status="warning" description="warning message" title="warning title"/>
<Profile subname="Here is the last name."/>
```

You can modify the status of the prompt as needed. The available options are: `info`, `success`, `warning` and `error`.
This extension will display a profile card within your post, where the avatar, name and profile will follow your settings in `site.ts`, and you can also specify them manually via `avatar="<image path>"`, `name="name"` and ``bio={`bio`}``.

You can also refer to the use case source code: [**Urara-Blog/+page.svelte.md at main · Sevichecc/Urara-Blog**](https://github.com/Sevichecc/Urara-Blog/blob/main/urara/2022-12-20-pleroma-mod/+page.svelte.md?plain=1#L12).
```md
<Profile name="name" avatar="/assets/maskable@512.png" subname="Here is the last name." bio={`Here is the bio <br>This is the second line of the bio.`} />
```

You can also refer to the use case source code: [**blog/+page.svelte.md at main · kwaa/blog**](https://github.com/kwaa/blog/blob/main/urara/about/+page.svelte.md?plain=1#L13).

</details>

Expand Down
45 changes: 23 additions & 22 deletions zh-hans/advanced/extension.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,67 +4,68 @@

## 文章组件

### 资料卡片
### 状态提示

#### 由 [藍+85CD](https://github.com/kwaa) 制作 | 演示 - [./kwaa.dev](https://kwaa.dev/about#关于我)
#### 由 [藍+85CD](https://github.com/kwaa) 制作 | 演示 - [Seviche.cc](https://seviche.cc/2022-12-20-pleroma-mod/)

<details>
<summary>配置</summary>

**⚠ 此拓展尚未包含在 Urara 中，您需要手动下载组件。**

下载 [**profile.svelte**](https://github.com/importantimport/urara-docs/raw/master/public/extension/profile/profile.svelte) 文件，将其放入 `src/lib/components/extra/` 目录内。
**✅ 此拓展已包含在 Urara 中，无需额外下载。**

#### 在使用前需导入组件：

```md
<script lang="ts">
import Profile from '$lib/components/extra/profile.svelte'
<script>
import Alert from '$lib/components/extra/alert.svelte'
</script>
```

#### 使用方法：

```md
<Profile subname="这里是姓氏"/>
<Alert status="warning" description="警告信息" title="警告标题"/>
```

此拓展会在您的文章内展示个人资料卡片，其中头像、姓名和简介会跟随您在 `site.ts` 的设定，您还可以通过 `avatar="<图片路径>"` 、 `name="姓名"` 和 ``bio={`简介`}`` 来手动指定它们：

```md
<Profile name="姓名" avatar="/assets/maskable@512.png" subname="这里是姓氏" bio={`这里是简介。<br>这是第二行简介。`} />
```
您可以根据需要修改提示的状态，可用的选项有：`info`、`success`、`warning` 和 `error`。

您还可以参考使用例源码：[**blog/+page.svelte.md at main · kwaa/blog**](https://github.com/kwaa/blog/blob/main/urara/about/+page.svelte.md?plain=1#L13)。
您还可以参考使用例源码：[**Urara-Blog/+page.svelte.md at main · Sevichecc/Urara-Blog**](https://github.com/Sevichecc/Urara-Blog/blob/main/urara/2022-12-20-pleroma-mod/+page.svelte.md?plain=1#L12)。

</details>

### 状态提示

#### 由 [藍+85CD](https://github.com/kwaa) 制作 | 演示 - [Seviche.cc](https://seviche.cc/2022-12-20-pleroma-mod/)
### 资料卡片

#### 由 [藍+85CD](https://github.com/kwaa) 制作 | 演示 - [./kwaa.dev](https://kwaa.dev/about#关于我)

<details>
<summary>配置</summary>

**✅ 此拓展已包含在 Urara 中，无需额外下载。**
**⚠ 此拓展尚未包含在 Urara 中，您需要手动下载组件。**

下载 [**profile.svelte**](https://github.com/importantimport/urara-docs/raw/master/public/extension/profile/profile.svelte) 文件，将其放入 `src/lib/components/extra/` 目录内。

#### 在使用前需导入组件：

```md
<script>
import Alert from '$lib/components/extra/alert.svelte'
<script lang="ts">
import Profile from '$lib/components/extra/profile.svelte'
</script>
```

#### 使用方法：

```md
<Alert status="warning" description="警告信息" title="警告标题"/>
<Profile subname="这里是姓氏"/>
```

您可以根据需要修改提示的状态，可用的选项有：`info`、`success`、`warning` 和 `error`。
此拓展会在您的文章内展示个人资料卡片，其中头像、姓名和简介会跟随您在 `site.ts` 的设定，您还可以通过 `avatar="<图片路径>"` 、 `name="姓名"` 和 ``bio={`简介`}`` 来手动指定它们：

您还可以参考使用例源码：[**Urara-Blog/+page.svelte.md at main · Sevichecc/Urara-Blog**](https://github.com/Sevichecc/Urara-Blog/blob/main/urara/2022-12-20-pleroma-mod/+page.svelte.md?plain=1#L12)。
```md
<Profile name="姓名" avatar="/assets/maskable@512.png" subname="这里是姓氏" bio={`这里是简介。<br>这是第二行简介。`} />
```

您还可以参考使用例源码：[**blog/+page.svelte.md at main · kwaa/blog**](https://github.com/kwaa/blog/blob/main/urara/about/+page.svelte.md?plain=1#L13)。

</details>

Expand Down
45 changes: 23 additions & 22 deletions zh/advanced/extension.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,67 +4,68 @@

## 文章組件

### 資料卡片
### 狀態提示

#### 由 [藍+85CD](https://github.com/kwaa) 製作 | 演示 - [./kwaa.dev](https://kwaa.dev/about#关于我)
#### 由 [藍+85CD](https://github.com/kwaa) 製作 | 演示 - [Seviche.cc](https://seviche.cc/2022-12-20-pleroma-mod/)

<details>
<summary>配置</summary>

**⚠ 此拓展尚未包含在 Urara 中，您需要手動下載組件。**

下載 [**profile.svelte**](https://github.com/importantimport/urara-docs/raw/master/public/extension/profile/profile.svelte) 文件，將其放入 `src/lib/components/extra/` 目錄內。
**✅ 此拓展已包含在 Urara 中，無需額外下載。**

#### 在使用前需導入組件：

```md
<script lang="ts">
import Profile from '$lib/components/extra/profile.svelte'
<script>
import Alert from '$lib/components/extra/alert.svelte'
</script>
```

#### 使用方法：

```md
<Profile subname="這裡是姓氏"/>
<Alert status="warning" description="警告資訊" title="警告標題"/>
```

此拓展會在您的文章內展示個人資料卡片，其中頭像、姓名和簡介會跟隨您在 `site.ts` 的設定，您還可以通過 `avatar="<圖片路徑>"` 、 `name="姓名"` 和 ``bio={`簡介`}`` 來手動指定它們：

```md
<Profile name="姓名" avatar="/assets/maskable@512.png" subname="這裡是姓氏" bio={`這裡是簡介。<br>這是第二行簡介。`} />
```
您可以根據需要修改提示的狀態，可用的選項有：`info`、`success`、`warning` 和 `error`。

您還可以參考使用例源碼：[**blog/+page.svelte.md at main · kwaa/blog**](https://github.com/kwaa/blog/blob/main/urara/about/+page.svelte.md?plain=1#L13)。
您還可以參考使用例源碼：[**Urara-Blog/+page.svelte.md at main · Sevichecc/Urara-Blog**](https://github.com/Sevichecc/Urara-Blog/blob/main/urara/2022-12-20-pleroma-mod/+page.svelte.md?plain=1#L12)。

</details>

### 狀態提示

#### 由 [藍+85CD](https://github.com/kwaa) 製作 | 演示 - [Seviche.cc](https://seviche.cc/2022-12-20-pleroma-mod/)
### 資料卡片

#### 由 [藍+85CD](https://github.com/kwaa) 製作 | 演示 - [./kwaa.dev](https://kwaa.dev/about#关于我)

<details>
<summary>配置</summary>

**✅ 此拓展已包含在 Urara 中，無需額外下載。**
**⚠ 此拓展尚未包含在 Urara 中，您需要手動下載組件。**

下載 [**profile.svelte**](https://github.com/importantimport/urara-docs/raw/master/public/extension/profile/profile.svelte) 文件，將其放入 `src/lib/components/extra/` 目錄內。

#### 在使用前需導入組件：

```md
<script>
import Alert from '$lib/components/extra/alert.svelte'
<script lang="ts">
import Profile from '$lib/components/extra/profile.svelte'
</script>
```

#### 使用方法：

```md
<Alert status="warning" description="警告資訊" title="警告標題"/>
<Profile subname="這裡是姓氏"/>
```

您可以根據需要修改提示的狀態，可用的選項有：`info`、`success`、`warning` 和 `error`。
此拓展會在您的文章內展示個人資料卡片，其中頭像、姓名和簡介會跟隨您在 `site.ts` 的設定，您還可以通過 `avatar="<圖片路徑>"` 、 `name="姓名"` 和 ``bio={`簡介`}`` 來手動指定它們：

您還可以參考使用例源碼：[**Urara-Blog/+page.svelte.md at main · Sevichecc/Urara-Blog**](https://github.com/Sevichecc/Urara-Blog/blob/main/urara/2022-12-20-pleroma-mod/+page.svelte.md?plain=1#L12)。
```md
<Profile name="姓名" avatar="/assets/maskable@512.png" subname="這裡是姓氏" bio={`這裡是簡介。<br>這是第二行簡介。`} />
```

您還可以參考使用例源碼：[**blog/+page.svelte.md at main · kwaa/blog**](https://github.com/kwaa/blog/blob/main/urara/about/+page.svelte.md?plain=1#L13)。

</details>

Expand Down

0 comments on commit 143286f

Please sign in to comment.