npm 包 wiki-plugin-code 使用教程

简介

Wiki-plugin-code 是一个 npm 包,可以在 Wiki 网站中方便地嵌入代码段,支持多种语言,并且具有灵活的参数配置功能。

安装

在命令行中输入以下命令进行安装:

--- ------- ----------------

使用

嵌入单行代码段

在 Wiki 的编辑器中输入以下代码:

------ -----------------

其中,语言为代码的语言类型,行号为起始行数,代码为要嵌入的代码段。

例如:

------ ------------------------------- ----------------

效果如下:

------------------ ---------

嵌入多行代码段

在 Wiki 的编辑器中输入以下代码:

------ -----------
----
------------

其中,语言为代码的语言类型,行号为起始行数,代码为多行代码段,每行代码之间用回车键分隔。

例如:

------ -------
--------- -----
------
------
    --------- ---- ------------
-------
------
    ----------- -- -- ----------
    ------- -- --- ------- -- -- ---------
-------
-------
-------

效果如下:

--------- -----
------
------
    --------- ---- ------------
-------
------
    ----------- -- -- ----------
    ------- -- --- ------- -- -- ---------
-------
-------

参数配置

代码段还支持用参数进行灵活的配置,可按需选择或指定显示行数、显示行号等。

可选的参数及其意义如下表:

参数 可选值 意义
lang 语言类型 指定代码的语言类型。
startline 1 或任意正整数 指定代码显示的起始行号。
highlight 单个或多个正整数 指定要高亮显示的行号,多个行号用逗号分隔。
collapse true 或 false 指定是否折叠长代码段。
title 任意字符串 在代码段上方显示指定的标题。
showTitle true 或 false 指定是否显示代码段的标题。
showLineNum true 或 false 指定是否显示代码段的行号。
width 数字(单位为像素) 指定代码段的宽度。
height 数字(单位为像素) 指定代码段的高度。
style 任意字符串 指定代码段的样式,可自定义 CSS 样式表。
delayLoad true 或 false 指定是否在页面加载完毕后再加载代码段,可优化页面加载速度。

例如:

------ ------------------------------------------------- ---- ------------------------------------------------------------- ----- -----
--- - - ---
--- - - ---
---------------- --- -- - --- - -- - - -- - -- - -----
-------

效果如下:

--- - - ---
--- - - ---
---------------- --- -- - --- - -- - - -- - -- - -----

注意事项

  • 如果代码段中包含特殊字符,需要使用 HTML 实体代替,例如 &#60; 代替 <&#62; 代替 > 等。
  • 如果代码段中包含 HTML 标签,需要在左右两侧加上 {html} 标签,例如 {html}<div>Hello World!</div>{/html}

总结

Wiki-plugin-code 是一个十分实用的 npm 包,可以为 Wiki 网站的代码嵌入提供便利和灵活性。在使用时需要注意参数的配置和特殊字符的转义,掌握好使用方法,可以极大地提高工作效率。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/the-wiki-plugin-code


猜你喜欢

  • npm 包 @jsonforms/core 使用教程

    简介 在现代化的 Web 开发中,前端框架和工具已经成为了必备的一部分,npm 包是其中非常重要的一个环节。npm 是一个名为 Node.js 包管理器的工具,它是 JavaScript 生态系统中最...

    4 年前
  • npm 包 ice-scripts 使用教程

    npm 包 ice-scripts 使用教程 随着前端开发技术的不断进步,前端工程化技术也越来越成熟和普及。其中,使用工具和框架来快速创建和构建前端项目成为了前端开发的一项重要技能。

    4 年前
  • npm 包 ice-plugin-moment-locales 使用教程

    在前端开发中,时间格式化是一个经常遇到的需求,而 Moment.js 是一个广泛使用的 Javascript 时间处理库。然而,由于 Moment.js 支持多种语言的本地化,因此其中的 locale...

    4 年前
  • npm 包 ice-plugin-fusion 使用教程

    前言 在前端开发中,我们经常需要使用 UI 框架来快速构建页面,阿里巴巴开源的 Fusion Design 框架是一个非常受欢迎的 UI 框架。在使用 飞冰(ICE) 这个阿里巴巴出品的前端应用开发框...

    4 年前
  • npm 包 ice-plugin-component 使用教程

    前言 在前端开发中,我们经常要使用组件来构建页面,常常需要重复开发相同的组件,造成大量的时间和精力浪费。为了解决这个问题,我们通常使用第三方组件库,但在实际应用中,使用第三方组件库的种类非常繁多,如何...

    4 年前
  • npm 包 @alifd/adaptor-generate 使用教程

    前言 在前端开发中,我们经常会在不同的项目中使用同一套组件库,这时候我们需要将组件库进行定制化开发。而 @alifd/adaptor-generate 就是一款可以快速生成组件适配层的工具,它能够帮助...

    4 年前
  • npm 包 @uform/next 使用教程

    前言 随着前端技术的发展,前端工程师们已经不再只是写一些简单的 HTML、CSS 和 JavaScript 了,我们还需要使用各种工具和框架来辅助我们的开发。其中,npm 是一个非常强大的工具,可以帮...

    4 年前
  • NPM包@aligov/components-gov-table使用教程

    介绍 在前端开发中,表格是非常常见的元素,但是手动构建一个复杂的表格会比较繁琐。@aligov/components-gov-table是一个由阿里巴巴开发的表格组件,它是基于React构建的,可以帮...

    4 年前
  • npm 包 react-docgen-typescript-webpack-plugin 使用教程

    在前端开发中,使用 TypeScript 开发 React 应用已经成为越来越流行的选择。在使用 TypeScript 进行 React 开发时,我们经常需要写很多的类型声明,这很容易增加开发工作的复...

    4 年前
  • npm 包 markdown-loader-jest 使用教程

    在前端开发中,Markdown 已经成为了重要的文档工具。而为了方便开发者测试 Markdown 文件,npm 上出现了 markdown-loader-jest 这个 npm 包。

    4 年前
  • npm 包 awsmobile-cli 使用教程

    介绍 在前端开发中,使用 AWS(亚马逊云服务)时,为了更高效地进行开发、部署和测试,我们需要使用 awsmobile-cli,它是 AWS 移动应用框架的命令行接口,提供了一系列便捷的工具和功能。

    4 年前
  • npm 包 @types/storybook__addon-options 使用教程

    前言 在我们使用 Storybook 进行组件开发时,我们通常需要使用一些插件来辅助我们的开发,而 @storybook/addon-options 就是其中之一。

    4 年前
  • npm 包 @types/recharts 使用教程

    简介 @types/recharts 是一个为 recharts 库提供类型声明文件的 npm 包。它可以帮助我们在编写 TypeScript 代码时更加友好地使用 recharts,提高代码的可读性...

    4 年前
  • npm 包 @types/react-intl 使用教程

    前言 React 是一个非常流行的前端框架,可用于构建 Web 应用程序和原生应用程序。@types/react-intl 是一种可以用来增加类型定义,提高代码可维护性和可读性的 npm 包。

    4 年前
  • npm 包 @types/paho-mqtt 使用教程

    在前端开发中,MQTT 协议在物联网应用中广泛使用。Paho 提供了 MQTT 的 JavaScript 客户端库,以便我们可以从 JavaScript 中访问 MQTT 协议。

    4 年前
  • npm包 aws-appsync使用教程

    在现代Web应用程序中,API的实时交互成为了一种必需的需求。这意味着我们需要在客户端和服务端之间建立实时通信。AWS AppSync是AWS Cloud服务中的一项用于构建实时应用程序和API的管理...

    4 年前
  • npm 包 aws-amplify-react 使用教程

    前言 随着云计算技术的不断普及,前端开发越来越依赖于云服务。AWS Amplify 是 Amazon Web Services 推出的一款针对移动和 Web 应用的开发平台,可以帮助开发人员轻松构建云...

    4 年前
  • npm 包 aws-amplify 使用教程

    AWS Amplify 是 AWS 官方提供的用于构建快速、可扩展的 Web 应用程序的开发平台。它可以使开发人员轻松地加入身份验证、存储、API 和即时通讯等功能,从而为前端开发人员提供了强大的工具...

    4 年前
  • npm 包 @fortawesome/free-regular-svg-icons 使用教程

    随着前端技术的发展,SVG 图标在网站和应用中的使用越来越普遍。在实现 SVG 图标的使用过程中,我们发现 FontAwesome 提供的免费 SVG 图标库 @fortawesome/free-re...

    4 年前
  • npm 包 @fortawesome/free-brands-svg-icons 使用教程

    在前端开发中,图标是一个非常重要的元素。可以用于美化页面、增加视觉层次,以及方便用户的使用体验。@fortawesome/free-brands-svg-icons 是一个非常好用的图标库,其中包含了...

    4 年前

相关推荐

    暂无文章