pengzhanbo / vuepress-theme-plume

Vuepress Theme. A simple, feature-rich, document & blog
https://theme-plume.vuejs.press
MIT License
48 stars 11 forks source link
blog document theme typescript vue vuepress vuepress-theme

vuepress-theme-plume

plume

[![npm version](https://img.shields.io/npm/v/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=npm)](https://www.npmjs.com/package/vuepress-theme-plume) [![npm download](https://img.shields.io/npm/dy/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=downloads)](https://www.npmjs.com/package/vuepress-theme-plume) ![peer dependency](https://img.shields.io/npm/dependency-version/vuepress-theme-plume/peer/vuepress?color=32A9C3&labelColor=1B3C4A) ![GitHub License](https://img.shields.io/github/license/pengzhanbo/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A)

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

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

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

Features

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