前端弃用

约 1292 字大约 4 分钟

2024-04-04

弃用说明

vuepress-plugin-md-enhance 在未来的版本会将 demo 相关的功能迁移至 vuepress/ecosystem, 详细进度请查看 ecosystem#293 。

但在基于用户反馈后发现，此功能在实际场景中使用表现不符合预期。存在以下问题：

vue-demo 仅能用于简单的组件演示，不能支持如组件库、composables-api 等外部依赖的演示。
演示代码仅能内联在 markdown 文件中，对于代码量较大的演示的编写体验不佳。
在浏览器运行时通过异步加载 babel 转换源代码，一方面需要额外的等待时间，另一方面对于企业内网环境可能不支持。

主题重新对前端代码演示功能进行了重新设计和重构，请查看新的前端代码演示。

概述

前端代码演示由 vuepress-plugin-md-enhance 提供支持。

前端代码演示默认不启用，你可以通过配置来启用它。

.vuepress/config.ts

export default defineUserConfig({
  theme: plumeTheme({
    plugins: {
      markdownEnhance: {
        demo: true,
      },
    }
  })
})

语法

::: [类型]-demo 可选的标题文字

```html
<!-- ↑ 使用可用的语言 -->
<!-- 在代码块中放置你对应语言的代码，一个语言不能出现多个块 -->
<!-- 你可以有多个代码块，并且 html, js, css 都是视情况可选的 -->
```

```json
// json block 作为插件配置存放处
{
  // 放置你的配置 (可选的)
}
```

:::

提示

JSON 块是可选的，可用的配置详见配置

插件支持三种类型

normal(默认)
vue
react

可用的语言

你可以在演示块中使用不同语言。

当你设置一些不能在浏览器上直接运行的语言时，由于插件无法解析它们，因此网页演示将被禁用。插件只显示代码。同时提供一个 "在 CodePen 中打开" 按钮允许用户直接在 CodePen 打开并浏览代码。

可用的 HTML 语言:

"html" (默认)
"slim"
"haml"
"markdown"

可用的 JS 语言:

"javascript" (default)
"coffeescript"
"babel"
"livescript"
"typescript"

你也可以在代码块中使用 js, ts, coffee 和 ls。

可用的 CSS 语言:

"css" (default)
"less"
"scss"
"sass"
"stylus"

不支持的语言

# 标题

十分强大

const message: string = 'VuePress Theme Hope'

document.querySelector('h1').innerHTML = message

h1 {
  font-style: italic;

  + p {
    color: red;
  }
}

代码

::: normal-demo 一个使用浏览器不支持解析语言 Demo

```md
# 标题

十分强大
```

```ts
const message: string = 'VuePress Theme Hope'

document.querySelector('h1').innerHTML = message
```

```scss
h1 {
  font-style: italic;

  + p {
    color: red;
  }
}
```

:::

普通代码演示

格式：

::: normal-demo 可选的标题文字

```html
<!-- html code -->
```

```js
// js code
```

```css
/* css code */
```

```json
// 配置 (可选)
{
  "jsLib": [
    // ...
  ],
  "cssLib": [
    // ...
  ]
}
```

:::

注意事项

我们使用 "ShadowDOM" 进行样式隔离，并已经将 document 替换为了 shadowRoot 对象。如果需要访问页面的 document，请访问 window.document。

例子

<h1>Hello Word!</h1>
<p><span id="very">非常</span>强大!</p>

document.querySelector('#very').addEventListener('click', () => {
  alert('非常强大')
})

span {
  color: red;
}

代码

::: normal-demo Demo 演示

```html
<h1>Hello Word!</h1>
<p><span id="very">非常</span>强大!</p>
```

```js
document.querySelector('#very').addEventListener('click', () => {
  alert('非常强大')
})
```

```css
span {
  color: red;
}
```

:::

Vue 代码演示

格式

::: vue-demo 可选的标题文字

```vue
<!-- ↑ 你也可以使用 html -->
<script>
export default {
  // vue 组件
}
</script>

<template>
  <!-- vue 模板 -->
  <div>demo</div>
</template>

<style>
/* css 代码 */
</style>
```

```json
// 配置 (可选)
{}
```

:::

注意事项

你只能使用 Vue3。
必须将组件通过 export default 默认导出
我们使用 "ShadowDOM" 进行样式隔离，并已经将 document 替换为了 shadowRoot 对象。如果需要访问页面的 document，请访问 window.document。

演示

<script>
const { ref } = Vue

export default {
  setup() {
    const message = ref('powerful')

    const handler = () => {
      message.value = `very ${message.value}`
    }

    return {
      message,
      handler,
    }
  },
}
</script>

<template>
  <div class="box">
    <code>Hello Word</code> is
    <span @click="handler">{{ message }}</span>!
  </div>
</template>

<style>
.box span {
  color: red;
}
</style>

代码

::: vue-demo 一个 Vue Composition 演示

```vue
<script>
const { ref } = Vue

export default {
  setup() {
    const message = ref('powerful')

    const handler = () => {
      message.value = `very ${message.value}`
    }

    return {
      message,
      handler,
    }
  },
}
</script>

<template>
  <div class="box">
    <code>Hello Word</code> is
    <span @click="handler">{{ message }}</span>!
  </div>
</template>

<style>
.box span {
  color: red;
}
</style>
```

:::

React 代码演示

格式

::: react-demo 可选的标题文字

```js
// 放置脚本，并通过 `export default` 导出你的 react 组件
```

```css
/* 你的 css 内容 */
```

```json
// 配置 (可选)
{}
```

:::

注意事项

使用 React 的时候，为了解析 JSX 必须引入 Babel，此过程由插件自动完成。
必须将组件通过 export default 默认导出
我们使用 "ShadowDOM" 进行样式隔离，并已经将 document 替换为了 shadowRoot 对象。如果需要访问页面的 document，请访问 window.document。

演示

const { useState } = React

export default () => {
  const [message, setMessage] = useState(' 强大')

  const handler = () => {
    setMessage(`十分${message}`)
  }

  return (
    <div className="box">
      <code>Hello Word !</code>
      <span id="powerful" onClick={handler}>
        {message}
      </span>
    </div>
  )
}

.box #powerful {
  color: blue;
}

代码

::: react-demo 一个函数式 React Demo

```js
const { useState } = React

export default () => {
  const [message, setMessage] = useState(' 强大')

  const handler = () => {
    setMessage(`十分${message}`)
  }

  return (
    <div className="box">
      <code>Hello Word !</code>
      <span id="powerful" onClick={handler}>
        {message}
      </span>
    </div>
  )
}
```

```css
.box #powerful {
  color: blue;
}
```

:::

贡献者

pengzhanbo

变更历史

最后更新于: 查看全部变更历史

4349a-
docs: update doc
于 2024/4/4
428b8-
docs: update code online repl doc
于 2024/4/24
a9f6b-
feat(plugin-md-power): add demo syntax (#415)
于 2025/1/10

前端 弃用

前端弃用