Skip to content

Commit 1984968

Browse files
committed
Updated docs
1 parent a02528b commit 1984968

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

DOCUMENTATION.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,14 @@ let converter = new showdown.Converter({
2121
})
2222
```
2323

24-
If you want to disable language [auto detection](https://highlightjs.org/usage/) feature of hljs, change `auto_detection` flag as `false`. With this option turned off, `showdown-highlight` will not process any codeblocks with no language specified.
24+
If you want to disable language [auto detection](https://highlightjs.org/usage/)
25+
feature of hljs, change `auto_detection` flag as `false`. With this option
26+
turned off, `showdown-highlight` will not process any codeblocks with no
27+
language specified.
2528

2629
```js
2730
let converter = new showdown.Converter({
2831
extensions: [showdownHighlight({ auto_detection: false })]
2932
})
30-
```
33+
```
34+

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,10 @@ const showdown = require('showdown')
8282
let converter = new showdown.Converter({
8383
// That's it
8484
extensions: [showdownHighlight({
85-
// Whether to add the classes to the <pre> tag
85+
// Whether to add the classes to the <pre> tag, default is false
8686
pre: true
87+
// Whether to use hljs' auto language detection, default is true
88+
, auto_detection: true
8789
})]
8890
});
8991

@@ -158,6 +160,17 @@ let converter = new showdown.Converter({
158160
})
159161
```
160162

163+
If you want to disable language [auto detection](https://highlightjs.org/usage/)
164+
feature of hljs, change `auto_detection` flag as `false`. With this option
165+
turned off, `showdown-highlight` will not process any codeblocks with no
166+
language specified.
167+
168+
```js
169+
let converter = new showdown.Converter({
170+
extensions: [showdownHighlight({ auto_detection: false })]
171+
})
172+
```
173+
161174

162175

163176

@@ -198,8 +211,8 @@ If you are using this library in one of your projects, add it in this list. :spa
198211
- `md-toy-blog`
199212
- `@kev_nz/publisher`
200213
- `@etermind/alex`
201-
- `@web-native-js/chtml-cli`
202214
- `@siradoc/siradoc`
215+
- `@web-native-js/chtml-cli`
203216
- `swanky`
204217
- `md-srv`
205218
- `docset-tools-markdown`
@@ -209,15 +222,15 @@ If you are using this library in one of your projects, add it in this list. :spa
209222
- `trumpdoc`
210223
- `@peersky/next-web3-chakra`
211224
- `mdpdf_jm`
225+
- `textbase`
226+
- `teroshdl`
227+
- `showdown-html`
212228
- `busi-ui`
213229
- `md-browse`
214230
- `markdown2dash`
215-
- `textbase`
216-
- `showdown-html`
217-
- `teroshdl`
218-
- `tutors-html`
219-
- `tutors-html-beta`
220231
- `tutors-reader-lib`
232+
- `tutors-html-beta`
233+
- `tutors-html`
221234
- `examma-ray`
222235
- `steelsky`
223236
- `chimpsky`

0 commit comments

Comments
 (0)