项目参考
本项目在开发过程中参考了多个优秀的开源项目，以下是主要的参考来源：
Mister-Hope 的 VuePress 主题
Mister-Hope 的 VitePress 主题是本项目最重要的参考来源之一。
自定义对齐
自定义内容对齐方式。
配置
ts
import { defineConfig } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
plugins: {
align: true
}
}
})预览
主题为你提供预览支持。
配置
ts
import { defineConfig } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
plugins: {
preview: true
}
}
})图片
让你的 VitePress 站点中的图片支持尺寸标注、懒加载、图片包裹等功能。
配置
ts
import { defineConfig } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
// 懒加载（可选）
image: {
lazyLoading: true
},
plugins: {
// 开启图片插件
image: true
// 或传入配置项
// image: { lazyLoading: true, focusable: false, linkImage: false }
}
}
})Inline Rule
统一的内联语法工厂工具函数，用于创建基于标点符号的自定义内联标签。
使用
ts
import { defineConfig, inlineRule } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
config(md) {
md.use(inlineRule, {
marker: "~",
tag: "sub",
token: "sub",
})
}
}
})标记
让你的 VitePress 站点中的 Markdown 文件支持标记。
配置
ts
import { defineConfig } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
plugins: {
mark: true
}
}
})剧透
在你的 VitePress 站点中添加剧透文字。
配置
ts
import { defineConfig } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
plugins: {
spoiler: true
}
}
})上下角标
让你的 VitePress 站点中的 Markdown 文件支持上下角标。
设置
ts
import { defineConfig } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
plugins: {
// 启用下角标
sub: true,
// 启用上角标
sup: true
}
}
})任务列表
让你的 VitePress 站点中的 Markdown 文件支持任务列表。
设置
ts
import { defineConfig } from 'vitepress-theme-niansi'
export default defineConfig({
markdown: {
plugins: {
tasklist: true
}
}
})