Config
You can pass these options to the plugin:
# baseLang
- Type:
string
- Default:
'en-US'
The language of the home directory.
# Enable all
- Type:
boolean
- Default:
false
Enable all features.
Warning
Please use this option ONLY for playing or testing.
As time grows,vupress-plugin-md-enhance
is becoming more powerful. It’s adding more syntax to Markdown parser and more code to output.
Enabling features you don’t need will increase dev and build time. (markdown-it
has to check for extra syntaxs)
Also, presentation feature will add a 700KB size chunk (mostly is reveal.js
) to your output.
Please use the options below and enable ONLY the feature you want to use.
# align
- Type:
boolean
- Default:
false
Whether to enable custom align.
# lineNumbers
- Type:
boolean
- Default:
true
Whether to display the line number to the left of each code block.
# sup
- Type:
boolean
- Default:
false
Whether to enable the upper format support.
# sub
- Type:
boolean
- Default:
false
Whether to enable the lower corner format support.
# footnote
- Type:
boolean
- Default:
false
Whether to enable footnote format support.
# mark
- Type:
boolean
- Default:
false
Whether to enable mark support.
# tex
- Type:
boolean
- Default:
false
Whether to enable syntax support.
# flowchart
- Type:
boolean
- Default:
false
Whether to enable flowchart syntax support.
# demo
- Type:
CodeDemoGlobalOptions | boolean
- Default:
false
Whether to enable code demo support.
# demo.jsLib
- Type:
string[]
- Required: No
CodePen, JsFiddle requires an external JS library for dating.
# demo.cssLib
- Type:
string[]
- Required: No
CodePen, JsFiddle need an external CSS library for dating.
Note
The above two options are only used by third-party code demo service, you need to import these libraries in head
.
# demo.jsfiddle
- Type:
boolean
- Default value:
true
Whether to display the JSFiddle button,
# demo.codepen
- Type:
boolean
- Default value:
true
Whether to display the CodePen button,
# demo.codepenLayout
- Type:
"top" | "left" | "correct"
- Default value:
"left"
CodePen editor layout
# demo.editors
- Type:
string
- Default value:
"101"
# others
The following are the library links used by the third-party code demo service. Unless your environment cannot visit jsdelivr or the speed is slow, don’t override the default values.
Note
Please note that if you use them, you still need to manually include them in your site using head
.
React depends on Babel.
# demo.vue
Default value: "https://cdn.jsdelivr.net/npm/vue/dist/vue.min.js"
# demo.react
Default value: "https://cdn.jsdelivr.net/npm/react/umd/react.production.min.js"
# demo.reactDOM
Default value: "https://cdn.jsdelivr.net/npm/react-dom/umd/react-dom.production.min.js"
# presentation
- Type:
PresentationOptions | boolean
- Default:
false
Whether to enable presentation syntax support.
You can set it with an object, the object will be used to config reveal.js.
# presentation.plugins
- Type:
string[]
- Required: No
Plugins you want to use on reveal.js.
Acceptable values are:
"highlight"
"math"
"search"
"notes"
"zoom"
# presentation.revealConfig
- Type:
Partial<RevealOptions>
- Required: No
Config which you want to pass to reveal.js.