Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Mister-Hope committed Oct 23, 2024
1 parent aebc3f9 commit e8d4be7
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 15 deletions.
5 changes: 0 additions & 5 deletions docs/.vuepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import process from 'node:process'
import { footnote } from '@mdit/plugin-footnote'
import { viteBundler } from '@vuepress/bundler-vite'
import { webpackBundler } from '@vuepress/bundler-webpack'
import { getRealPath } from '@vuepress/helper'
Expand Down Expand Up @@ -74,10 +73,6 @@ export default defineUserConfig({
},
},

extendsMarkdown: (md) => {
md.use(footnote)
},

// configure default theme
theme,

Expand Down
1 change: 1 addition & 0 deletions docs/.vuepress/configs/sidebar/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ export const sidebarEn: SidebarOptions = {
'/plugins/markdown/': [
'append-date',
'markdown-container',
'markdown-ext',
'markdown-image',
'markdown-hint',
'markdown-math',
Expand Down
1 change: 1 addition & 0 deletions docs/.vuepress/configs/sidebar/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ export const sidebarZh: SidebarOptions = {
'/zh/plugins/markdown/': [
'append-date',
'markdown-container',
'markdown-ext',
'markdown-image',
'markdown-hint',
'markdown-math',
Expand Down
1 change: 0 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
"docs:serve": "http-server -a localhost .vuepress/dist"
},
"dependencies": {
"@mdit/plugin-footnote": "0.13.1",
"@vuepress/bundler-vite": "2.0.0-rc.18",
"@vuepress/bundler-webpack": "2.0.0-rc.18",
"@vuepress/plugin-back-to-top": "workspace:*",
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/markdown/markdown-ext.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export default {

- If there are multiple paragraphs in footnote, the paragraph show be double indented

::: details demo
::: details Demo

Footnote 1 link[^first].

Expand Down Expand Up @@ -105,7 +105,7 @@ You can use component fence block to add a component into your markdown content.
```
````

::: demo Details
::: details Demo

```component Badge
text: Mr.Hope
Expand Down Expand Up @@ -139,7 +139,7 @@ type: tip

You can use any mustache syntax as raw text in `v-pre` container:

:::: details Detail
::: details Demo

::: v-pre

Expand Down
6 changes: 3 additions & 3 deletions docs/zh/plugins/markdown/markdown-ext.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export default {

- 如果脚注包含多个段落,其后的段落应当保持双层缩进。

::: demo 例子
::: details 示例

脚注 1 链接[^链接1]

Expand Down Expand Up @@ -105,7 +105,7 @@ export default {
```
````

::: demo 详情
::: details 示例

```component Badge
text: Mr.Hope
Expand Down Expand Up @@ -137,7 +137,7 @@ type: tip

你可以使用 `v-pre` 容器来渲染将任何 mustache 语法作为纯文本渲染。

:::: details 详情
::: details 示例

::: v-pre

Expand Down
3 changes: 0 additions & 3 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit e8d4be7

Please sign in to comment.