介绍
to-gfm-code-block
是一个NPM包,可以将代码块转换为GitHub风格的代码块。它支持语言高亮,并可以生成带行号的代码块。
安装
--- ------- -----------------
使用方法
基本用法
----- -------------- - ----------------------------- ----- ---- - - -------- ------ -- - ------ - - -- - -- ----- ---- - ----- ----- ------ - -------------------- ------ --------------------
输出:
```js
function add(a, b) {
return a + b;
}
```
指定选项
----- -------------- - ----------------------------- ----- ---- - - -------- ------ -- - ------ - - -- - -- ----- ---- - ----- ----- ------- - - ----------- ----- ---------- - -- ----- ------ - -------------------- ----- --------- --------------------
输出:
```js
1. function add(a, b) {
2. return a + b;
3. }
```
支持的语言
以下是支持的语言列表:
- actionscript
- apache
- applescript
- bash
- c
- csharp
- cpp
- css
- coffeescript
- diff
- django
- dockerfile
- go
- groovy
- html
- http
- ini
- java
- javascript
- json
- kotlin
- less
- lua
- markdown
- matlab
- nginx
- objectivec
- perl
- php
- plaintext
- powershell
- python
- r
- ruby
- rust
- scala
- shell
- sql
- swift
- typescript
- vb
- xml
- yaml
选项
以下是可以使用的选项:
lineNumber
:是否在代码块前面显示行号,默认为false
lineStart
:起始行号,默认为1
highlight
:指定需要高亮的行,例如[1,2,5]
总结
to-gfm-code-block
是一个非常方便的NPM包,可以轻松地将代码块转换为GitHub风格的代码块,并支持语言高亮和行号。这个包的使用方法也非常简单,只需要几行代码就可以完成转换。如果你是一个前端开发人员,并且常常需要在GitHub上分享代码,那么这个包一定会给你带来很大的便利。
来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/51986