You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/configuration.md
+35-28
Original file line number
Diff line number
Diff line change
@@ -365,7 +365,7 @@ window.$docsify = {
365
365
366
366
## autoHeader
367
367
368
-
-type: `Boolean`
368
+
-Type: `Boolean`
369
369
370
370
If `loadSidebar` and `autoHeader` are both enabled, for each link in `_sidebar.md`, prepend a header to the page before converting it to HTML. See [#78](https://github.com/docsifyjs/docsify/issues/78).
371
371
@@ -378,7 +378,7 @@ window.$docsify = {
378
378
379
379
## executeScript
380
380
381
-
-type: `Boolean`
381
+
-Type: `Boolean`
382
382
383
383
Execute the script on the page. Only parse the first script tag ([demo](themes)). If Vue is present, it is turned on by default.
384
384
@@ -400,8 +400,8 @@ Note that if you are running an external script, e.g. an embedded jsfiddle demo,
400
400
401
401
## nativeEmoji
402
402
403
-
-type: `Boolean`
404
-
-default: `false`
403
+
-Type: `Boolean`
404
+
-Default: `false`
405
405
406
406
Render emoji shorthand codes using GitHub-style emoji images or platform-native emoji characters.
407
407
@@ -453,8 +453,8 @@ To render shorthand codes as text, replace `:` characters with the `:` HTM
453
453
454
454
## noEmoji
455
455
456
-
-type: `Boolean`
457
-
-default: `false`
456
+
-Type: `Boolean`
457
+
-Default: `false`
458
458
459
459
Disabled emoji parsing and render all emoji shorthand as text.
460
460
@@ -492,7 +492,7 @@ To disable emoji parsing of individual shorthand codes, replace `:` characters w
492
492
493
493
## mergeNavbar
494
494
495
-
-type: `Boolean`
495
+
-Type: `Boolean`
496
496
497
497
Navbar will be merged with the sidebar on smaller screens.
498
498
@@ -504,7 +504,7 @@ window.$docsify = {
504
504
505
505
## formatUpdated
506
506
507
-
-type: `String|Function`
507
+
-Type: `String|Function`
508
508
509
509
We can display the file update date through **{docsify-updated<span>}</span>** variable. And format it by `formatUpdated`.
510
510
See https://github.com/lukeed/tinydate#patterns
@@ -523,8 +523,8 @@ window.$docsify = {
523
523
524
524
## externalLinkTarget
525
525
526
-
-type: `String`
527
-
-default: `_blank`
526
+
-Type: `String`
527
+
-Default: `_blank`
528
528
529
529
Target to open external links inside the markdown. Default `'_blank'` (new window/tab)
530
530
@@ -536,8 +536,8 @@ window.$docsify = {
536
536
537
537
## cornerExternalLinkTarget
538
538
539
-
-type:`String`
540
-
-default:`_blank`
539
+
-Type:`String`
540
+
-Default:`_blank`
541
541
542
542
Target to open external link at the top right corner. Default `'_blank'` (new window/tab)
543
543
@@ -549,8 +549,8 @@ window.$docsify = {
549
549
550
550
## externalLinkRel
551
551
552
-
-type: `String`
553
-
-default: `noopener`
552
+
-Type: `String`
553
+
-Default: `noopener`
554
554
555
555
Default `'noopener'` (no opener) prevents the newly opened external page (when [externalLinkTarget](#externallinktarget) is `'_blank'`) from having the ability to control our page. No `rel` is set when it's not `'_blank'`. See [this post](https://mathiasbynens.github.io/rel-noopener/) for more information about why you may want to use this option.
556
556
@@ -562,8 +562,8 @@ window.$docsify = {
562
562
563
563
## routerMode
564
564
565
-
-type: `String`
566
-
-default: `hash`
565
+
-Type: `String`
566
+
-Default: `hash`
567
567
568
568
```js
569
569
window.$docsify= {
@@ -573,7 +573,7 @@ window.$docsify = {
573
573
574
574
## crossOriginLinks
575
575
576
-
-type: `Array`
576
+
-Type: `Array`
577
577
578
578
When `routerMode: 'history'`, you may face cross-origin issues. See [#1379](https://github.com/docsifyjs/docsify/issues/1379).
579
579
In Markdown content, there is a simple way to solve it: see extends Markdown syntax `Cross-Origin link` in [helpers](helpers.md).
@@ -586,7 +586,7 @@ window.$docsify = {
586
586
587
587
## noCompileLinks
588
588
589
-
-type: `Array<string>`
589
+
-Type: `Array<string>`
590
590
591
591
Sometimes we do not want docsify to handle our links. See [#203](https://github.com/docsifyjs/docsify/issues/203). We can skip compiling of certain links by specifying an array of strings. Each string is converted into to a regular expression (`RegExp`) and the _whole_ href of a link is matched against it.
592
592
@@ -598,7 +598,7 @@ window.$docsify = {
598
598
599
599
## onlyCover
600
600
601
-
-type: `Boolean`
601
+
-Type: `Boolean`
602
602
603
603
Only coverpage is loaded when visiting the home page.
604
604
@@ -610,7 +610,7 @@ window.$docsify = {
610
610
611
611
## requestHeaders
612
612
613
-
-type: `Object`
613
+
-Type: `Object`
614
614
615
615
Set the request resource headers.
616
616
@@ -634,7 +634,7 @@ window.$docsify = {
634
634
635
635
## ext
636
636
637
-
-type: `String`
637
+
-Type: `String`
638
638
639
639
Request file extension.
640
640
@@ -646,7 +646,7 @@ window.$docsify = {
646
646
647
647
## fallbackLanguages
648
648
649
-
-type: `Array<string>`
649
+
-Type: `Array<string>`
650
650
651
651
List of languages that will fallback to the default language when a page is requested and it doesn't exist for the given locale.
652
652
@@ -664,7 +664,7 @@ window.$docsify = {
664
664
665
665
## notFoundPage
666
666
667
-
-type: `Boolean` | `String` | `Object`
667
+
-Type: `Boolean` | `String` | `Object`
668
668
669
669
Load the `_404.md` file:
670
670
@@ -697,8 +697,8 @@ window.$docsify = {
697
697
698
698
## topMargin
699
699
700
-
-type: `Number`
701
-
-default: `0`
700
+
-Type: `Number`
701
+
-Default: `0`
702
702
703
703
Adds a space on top when scrolling the content page to reach the selected section. This is useful in case you have a _sticky-header_ layout and you want to align anchors to the end of your header.
704
704
@@ -710,7 +710,7 @@ window.$docsify = {
710
710
711
711
## vueComponents
712
712
713
-
-type: `Object`
713
+
-Type: `Object`
714
714
715
715
Creates and registers global [Vue components](https://vuejs.org/v2/guide/components.html). Components are specified using the component name as the key with an object containing Vue options as the value. Component `data` is unique for each instance and will not persist as users navigate the site.
716
716
@@ -743,7 +743,7 @@ window.$docsify = {
743
743
744
744
## vueGlobalOptions
745
745
746
-
-type: `Object`
746
+
-Type: `Object`
747
747
748
748
Specifies [Vue options](https://vuejs.org/v2/api/#Options-Data) for use with Vue content not explicitly mounted with [vueMounts](#mounting-dom-elements), [vueComponents](#components), or a [markdown script](#markdown-script). Changes to global `data` will persist and be reflected anywhere global references are used.
749
749
@@ -777,7 +777,7 @@ window.$docsify = {
777
777
778
778
## vueMounts
779
779
780
-
-type: `Object`
780
+
-Type: `Object`
781
781
782
782
Specifies DOM elements to mount as [Vue instances](https://vuejs.org/v2/guide/instance.html) and their associated options. Mount elements are specified using a [CSS selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors) as the key with an object containing Vue options as their value. Docsify will mount the first matching element in the main content area each time a new page is loaded. Mount element `data` is unique for each instance and will not persist as users navigate the site.
783
783
@@ -808,3 +808,10 @@ window.$docsify = {
808
808
{{ count }}
809
809
<button @click="count += 1">+</button>
810
810
</output>
811
+
812
+
## catchPluginErrors
813
+
814
+
- Type: `Boolean`
815
+
- Default: `true`
816
+
817
+
Determines if Docsify should handle uncaught _synchronous_ plugin errors automatically. This can prevent plugin errors from affecting docsify's ability to properly render live site content.
0 commit comments