简介
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 实体代替,例如
<
代替<
,>
代替>
等。 - 如果代码段中包含 HTML 标签,需要在左右两侧加上
{html}
标签,例如{html}<div>Hello World!</div>{/html}
。
总结
Wiki-plugin-code 是一个十分实用的 npm 包,可以为 Wiki 网站的代码嵌入提供便利和灵活性。在使用时需要注意参数的配置和特殊字符的转义,掌握好使用方法,可以极大地提高工作效率。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/the-wiki-plugin-code