vuepress-theme-plume
TypeScript icon, indicating that this package has built-in type declarations

1.0.0-rc.108 • Public • Published

vuepress-theme-plume

vuepress=theme-plume

npm version npm download peer dependency GitHub License

一个简约的,干净的,容易上手的 vuepress 主题,适用于博客和文档。

开箱即用,仅需少量配置即可使用,让您更专注于 内容的创作,更好的表达你的想法,形成你的知识笔记。

内置了丰富的强大的功能,旨在让内容更具有表现力。

Features

  • 💻 响应式布局,适配不同的屏幕尺寸
  • 📖 博客 & 文档
  • 🔗 自动生成文章永久链接
  • ⚖ 支持多语言
  • 🔑 支持 全站加密、部分加密
  • 👀 支持 搜索、文章评论
  • 👨‍💻‍ 支持 浅色/深色 主题 (包括代码高亮)
  • 📠 markdown 增强,支持 代码块分组、提示容器、任务列表、数学公式、代码演示 等
  • 📚 嵌入代码演示,支持 CodePen, JSFiddle, CodeSandbox 等
  • 📊 嵌入图表,支持 chart.js,Echarts,Mermaid,flowchart
  • 🎛 资源嵌入,支持 PDF, bilibili视频,youtube视频等
  • 🪞 支持全站水印、部分内容水印

Install

npm install vuepress@next vuepress-theme-plume
# or
pnpm add vuepress@next vuepress-theme-plume vue
# or
yarn add vuepress@next vuepress-theme-plume

Usage

import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'

export default defineUserConfig({
  // vuepress config...
  theme: plumeTheme({
    // theme config...
  })
})

plumeTheme(options)

options : PlumeThemeOptions

查看 options 详细说明

注意

本主题基于 vuepress 2 ,处于 RC 阶段。

这意味着功能已趋于稳定,但在未来仍有小概率发生破坏性更改。

贡献指南

查看 [贡献指南] 了解更多

LICENSE

MIT

Package Sidebar

Install

npm i vuepress-theme-plume

Weekly Downloads

478

Version

1.0.0-rc.108

License

MIT

Unpacked Size

537 kB

Total Files

128

Last publish

Collaborators

  • pengzhanbo