返回

网页代码美化之如何用Vite轻松展示你的代码?

前端

利用 Vite 美化和展示源代码:一个开发者指南

作为开发者,我们经常需要在网页中展示源代码,例如技术文档、组件库和教程。然而,直接粘贴代码会影响网页美观度和可读性。本文将介绍如何使用 Vite,一个现代前端构建工具,来轻松展示代码。

步骤一:自定义 Vite

在 Vite 配置文件 vite.config.js 中,添加以下代码启用代码块支持:

module.exports = {
  plugins: [
    {
      name: 'markdown-it',
      configure: (md) => {
        md.use(require('markdown-it-highlightjs'))
      }
    }
  ]
}

步骤二:在 Markdown 中添加代码块

使用三个反引号 ``` 包裹代码,并指定语言,例如:

// 代码块
```javascript
console.log('Hello World!');

**步骤三:生成静态站点** 

使用命令 `vite build` 生成静态站点,代码块将自动高亮显示:

vite build


**Vite Markdown 代码块插件** 

Vite 提供了多种代码块插件来增强展示效果:

* **markdown-it-highlightjs:**  语法高亮
* **markdown-it-prism:**  语法高亮,更多主题选择
* **markdown-it-block:**  代码块折叠
* **markdown-it-line-numbers:**  行号显示
* **markdown-it-copy-code:**  代码块复制

**总结** 

使用 Vite,开发者可以轻松美化和展示源代码,提升代码可读性和网页美观度。Vite 的代码块支持功能丰富,包括语法高亮、行号、折叠和复制等。这些功能可帮助开发者更有效地展示和理解代码。

**常见问题解答** 

1. **如何折叠代码块?** 
   使用 markdown-it-block 插件,添加 `data-markdown-block` 属性,例如:
   
   ```html
   <pre data-markdown-block><code>...</code></pre>
  1. 如何复制代码块?
    使用 markdown-it-copy-code 插件,添加 data-markdown-copy 属性,例如:

    <pre data-markdown-copy><code>...</code></pre>
    
  2. 如何使用不同主题高亮代码?
    安装 markdown-it-prism 插件,并指定主题,例如:

    md.use(require('markdown-it-prism'), {
      theme: 'okaidia'
    })
    
  3. 如何设置行号?
    使用 markdown-it-line-numbers 插件,添加 data-markdown-line-numbers 属性,例如:

    <pre data-markdown-line-numbers><code>...</code></pre>
    
  4. 如何配置代码块的语言?
    在代码块的开头指定语言,例如:

    ```javascript
    console.log('Hello World!');