Acknowledgements
This project draws inspiration and reference from several excellent open-source projects during its development. Here are the main sources:
Custom alignment
Settings
ts
import { defineConfig } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
plugins: {
align: true
}
}
})Preview
The theme provides you preview support.
Settings
ts
import { defineConfig } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
plugins: {
preview: true
}
}
})Image
Adds image size syntax, lazy loading, and figure wrapping support for images in your VitePress site.
Config
ts
import { defineConfig } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
// Lazy loading (optional)
image: {
lazyLoading: true
},
plugins: {
// Enable image plugin
image: true
// Or pass options
// image: { lazyLoading: true, focusable: false, linkImage: false }
}
}
})Inline Rule
A unified inline syntax factory plugin for creating custom punctuation-based inline tags.
Usage
ts
import { defineConfig, inlineRule } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
config(md) {
md.use(inlineRule, {
marker: "~",
tag: "sub",
token: "sub",
})
}
}
})Mark
Make your Markdown files in your VitePress site support mark.
Settings
ts
import { defineConfig } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
plugins: {
mark: true
}
}
})Spoiler
Hide spoiler contents in your VitePress site.
Setting
ts
import { defineConfig } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
plugins: {
spoiler: true
}
}
})Superscript and Subscript
Setting
ts
import { defineConfig } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
plugins: {
// Enable Subscript
sub: true,
// Enable Superscript
sup: true
}
}
})Task list
Let the Markdown file in your VitePress site support task list.
Setting
ts
import { defineConfig } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
plugins: {
tasklist: true
}
}
})