88 lines
4.4 KiB
Markdown
88 lines
4.4 KiB
Markdown
---
|
|
title: Introduction
|
|
icon: mdi:tooltip-text-outline
|
|
createTime: 2025/10/08 11:06:24
|
|
permalink: /en/guide/intro/
|
|
tags:
|
|
- Guide
|
|
- Quick Start
|
|
---
|
|
|
|
==vuepress-theme-plume== is a modern theme built on VuePress, designed to meet your diverse needs,
|
|
whether you are creating a **technical blog**, **personal journal**, **product documentation**,
|
|
**knowledge base**, or **tutorial series**.
|
|
|
|
Deep optimizations have been applied to typography and image display,
|
|
with extensive enhancements specifically for Markdown syntax. This allows you to effortlessly
|
|
create professional content that is **aesthetically pleasing, highly readable, and expressive**.
|
|
|
|
::: details New to VuePress?
|
|
|
|
VuePress is a [Static Site Generator](https://en.wikipedia.org/wiki/Static_site_Generator) (SSG)
|
|
specifically designed for building high-performance content-centric websites.
|
|
In simple terms,it takes your Markdown content, renders it through a theme,
|
|
and generates static HTML pages that can be deployed anywhere.
|
|
:::
|
|
|
|
[Visit the **VuePress Official Website** to learn more](https://v2.vuepress.vuejs.org/zh/){.read-more}
|
|
|
|
## Core Advantages
|
|
|
|
Significant improvements are offered compared to the default VuePress theme:
|
|
|
|
### 🎨 Superior User Experience
|
|
|
|
The interface design and interaction logic have been comprehensively optimized to deliver
|
|
a more beautiful, clean, and user-friendly reading experience.
|
|
|
|
### 🚀 Rich Feature Set
|
|
|
|
- **Diverse Layouts**: Support for fully customizable ==homepage==, with optional ==article list== and ==documentation== modes.
|
|
- **Content Enhancement**: Built-in practical features such as ==full-text search==, ==article comments==,
|
|
==content encryption==, and ==article watermarking==.
|
|
- **Code Presentation**: Support for code block ==grouping==, ==collapsing==, ==focusing==,
|
|
==line highlighting==, ==diff comparison==, and embedding ==code demos== from platforms like CodePen, JSFiddle, and CodeSandbox.
|
|
- **Icon System**: Integration with [iconify](https://icon-sets.iconify.design/) providing access to
|
|
**200,000+** ==icons==, with optional support for `iconfont` / `fontawesome` icon libraries.
|
|
- **Media Embedding**: Support for ==PDF embedding==, and ==Bilibili/Youtube/Local Video== embedding.
|
|
- **Chart Rendering**: Integration with multiple ==chart engines== including chart.js, Echarts, Mermaid, Flowchart, Markmap, and PlantUML.
|
|
- **Layout Containers**: Flexible Markdown container syntax providing ==callout containers==,
|
|
==file trees==, ==code trees==, ==card containers==, ==waterfall flow containers==, and more.
|
|
- **Extensibility**: Support for ==layout slots==, ==component overrides==, and ==custom styles==,
|
|
enabling easy implementation of personalized layout designs.
|
|
|
|
### 🎉 Everything is a "Collection"
|
|
|
|
Content is organized into multiple ==collections==. Each collection has its own independent directory.
|
|
Based on different collection types, diverse requirements such as **blogs**, **columns**,
|
|
**tutorial series**, **knowledge bases**, and **product documentation** can be easily achieved.
|
|
|
|
### ⚡ Efficient Development Experience
|
|
|
|
A compilation caching mechanism is introduced, caching the compilation results of Markdown files
|
|
and the parsing results of complex code blocks, significantly improving build speed.
|
|
|
|
### 🔧 Intelligent Configuration Management
|
|
|
|
Support for independent theme configuration files avoids frequent VuePress service restarts caused by
|
|
configuration changes. This maintains configuration flexibility while substantially simplifying the
|
|
configuration process and lowering the barrier to use.
|
|
|
|
### 🌟 Out-of-the-Box Solution
|
|
|
|
The ==plume theme== comes pre-integrated with the common features and configurations needed to build a site.
|
|
This allows you to **focus on content creation** without worrying about technical details,
|
|
fully leveraging the enhanced Markdown syntax to better express your ideas.
|
|
|
|
::: tip Version Information
|
|
|
|
This theme is developed based on [vuepress-next](https://github.com/vuepress/vuepress-next) and is currently in the Release Candidate (RC) stage.
|
|
|
|
The functionality and APIs in the current version are relatively stable, but breaking changes might still occur in future updates.
|
|
|
|
If you encounter any issues or have suggestions for improvement, please feel free to raise them in the
|
|
[Issues](https://github.com/pengzhanbo/vuepress-theme-plume/issues). Contributions via
|
|
[Pull Requests (PR)](https://github.com/pengzhanbo/vuepress-theme-plume/pulls) are also welcome to help improve the theme.
|
|
|
|
:::
|