1 Star 1 Fork 0

鹏展博 / vuepress-theme-plume

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

vuepress-theme-plume

plume

npm version npm download peer dependency GitHub License

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

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

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

Features

  • 💻 响应式布局,适配不同的屏幕尺寸
  • 📖 博客 & 文档
  • 🔗 自动生成文章永久链接
  • ⚖ 支持多语言
  • 🔑 支持 全站加密、部分加密
  • 👀 支持 搜索、文章评论
  • 👨‍💻‍ 支持 浅色/深色 主题 (包括代码高亮)
  • 📠 markdown 增强,支持 代码块分组、提示容器、任务列表、数学公式、代码演示 等
  • 📚 嵌入代码演示,支持 CodePen, Replit, 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 阶段。

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

贡献指南

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

效果图

home page

home

blog page

blog

post page

post

note page

note

The MIT License (MIT) Copyright (C) 2021 - PRESENT by pengzhanbo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

Vuepress Theme. A simple, feature-rich, document & blog 展开 收起
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
TypeScript
1
https://gitee.com/pengzb/vuepress-theme-plume.git
git@gitee.com:pengzb/vuepress-theme-plume.git
pengzb
vuepress-theme-plume
vuepress-theme-plume
main

搜索帮助