docs: update docs
This commit is contained in:
pengzhanbo
parent
cd68f1cdd9
commit
479680bba6
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
pageLayout: home
|
pageLayout: home
|
||||||
|
title: Vuepress Theme Plume
|
||||||
config:
|
config:
|
||||||
-
|
-
|
||||||
type: hero
|
type: hero
|
||||||
@ -37,7 +38,7 @@ config:
|
|||||||
-
|
-
|
||||||
title: Multi-language
|
title: Multi-language
|
||||||
icon: twemoji:balance-scale
|
icon: twemoji:balance-scale
|
||||||
details: Built-in support for Chinese/English, and you can customize and add more language support
|
details: Built-in support for 7 languages including Chinese and English, and you can customize and add more language support
|
||||||
-
|
-
|
||||||
title: Dual Color Theme
|
title: Dual Color Theme
|
||||||
icon: twemoji:cityscape
|
icon: twemoji:cityscape
|
||||||
@ -57,7 +58,7 @@ config:
|
|||||||
-
|
-
|
||||||
title: Markdown Enhancement
|
title: Markdown Enhancement
|
||||||
icon: twemoji:writing-hand-light-skin-tone
|
icon: twemoji:writing-hand-light-skin-tone
|
||||||
details: Supports Markdown syntax, code block grouping, hint containers, task lists, mathematical formulas, code demonstrations, etc.
|
details: Based on regular markdown syntax, adds dozens of enhanced syntaxes such as custom containers, file trees, code groups, etc.
|
||||||
-
|
-
|
||||||
type: image-text
|
type: image-text
|
||||||
title: Features
|
title: Features
|
||||||
@ -69,7 +70,7 @@ config:
|
|||||||
description: Add tags, categories, word count, reading time, writing date, and other information to articles.
|
description: Add tags, categories, word count, reading time, writing date, and other information to articles.
|
||||||
-
|
-
|
||||||
title: Comments
|
title: Comments
|
||||||
description: Supports 4 comment systems： Giscus, Waline, Twikoo, Artalk<br>You can freely choose the comment system that suits your needs.
|
description: "Supports 4 comment systems: Giscus, Waline, Twikoo, Artalk<br>You can freely choose the comment system that suits your needs."
|
||||||
-
|
-
|
||||||
title: Search
|
title: Search
|
||||||
description: Supports local search based on minisearch, and also supports Algolia search.
|
description: Supports local search based on minisearch, and also supports Algolia search.
|
||||||
@ -81,7 +82,7 @@ config:
|
|||||||
description: Code copying, CodePen demonstration, JSFiddle demonstration, CodeSandbox demonstration, code groups, line highlighting, line focusing, line warnings, difference comparison, code block folding, etc.
|
description: Code copying, CodePen demonstration, JSFiddle demonstration, CodeSandbox demonstration, code groups, line highlighting, line focusing, line warnings, difference comparison, code block folding, etc.
|
||||||
-
|
-
|
||||||
title: Resource Embedding
|
title: Resource Embedding
|
||||||
description: Charts：chart.js/ECharts/Mermaid/flowchart<br>Videos：Bilibili/Youtube/ArtPlayer<br>PDF, 200K+ Iconify icons
|
description: "Charts: chart.js/ECharts/Mermaid/flowchart<br>Videos: Bilibili/Youtube/ArtPlayer<br>PDF, 200K+ Iconify icons"
|
||||||
-
|
-
|
||||||
type: text-image
|
type: text-image
|
||||||
title: Blog
|
title: Blog
|
||||||
@ -116,64 +117,48 @@ config:
|
|||||||
<div style="max-width: 960px;margin:0 auto;" class="home-custom-content">
|
<div style="max-width: 960px;margin:0 auto;" class="home-custom-content">
|
||||||
|
|
||||||
::: center
|
::: center
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{.no-view}
|
||||||
|
{.no-view}
|
||||||
|
{.no-view}
|
||||||
|
{.no-view}
|
||||||
|
{.no-view}
|
||||||
|
|
||||||
|
{.no-view}
|
||||||
|
{.no-view}
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
### Installation
|
### Usage
|
||||||
|
|
||||||
:::code-tabs
|
Use the following command to quickly create a new ==VuePress== project using this theme.
|
||||||
@tab pnpm
|
|
||||||
|
:::npm-to
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
pnpm add vuepress@next vuepress-theme-plume vue
|
npm create vuepress-theme-plume@latest
|
||||||
```
|
|
||||||
|
|
||||||
@tab npm
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npm install vuepress@next vuepress-theme-plume
|
|
||||||
```
|
|
||||||
|
|
||||||
@tab yarn
|
|
||||||
|
|
||||||
```sh
|
|
||||||
yarn add vuepress@next vuepress-theme-plume
|
|
||||||
```
|
```
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
### Configuration
|
### Start the project
|
||||||
|
|
||||||
::: code-tabs
|
::: npm-to
|
||||||
@tab .vuepress/config.ts
|
|
||||||
|
|
||||||
```ts :no-line-numbers
|
```sh
|
||||||
import { defineUserConfig } from 'vuepress'
|
npm run docs:dev
|
||||||
import { plumeTheme } from 'vuepress-theme-plume'
|
|
||||||
|
|
||||||
export default defineUserConfig({
|
|
||||||
// vuepress config...
|
|
||||||
theme: plumeTheme({
|
|
||||||
// theme config...
|
|
||||||
})
|
|
||||||
})
|
|
||||||
```
|
```
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
### Update Log
|
### Changelog
|
||||||
|
|
||||||
[Changelog](../changelog)
|
[Changelog](./changelog)
|
||||||
|
|
||||||
### Contributors
|
### Contributors
|
||||||
|
|
||||||
|
Thanks to all contributors!
|
||||||
|
|
||||||
<Contributors :contributors="data" />
|
<Contributors :contributors="data" />
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
294
docs/en/demos.md
Normal file
294
docs/en/demos.md
Normal file
@ -0,0 +1,294 @@
|
|||||||
|
---
|
||||||
|
title: Demos
|
||||||
|
createTime: 2025/10/08 19:22:07
|
||||||
|
permalink: /en/demos/
|
||||||
|
readingTime: false
|
||||||
|
prev: false
|
||||||
|
next: false
|
||||||
|
article: false
|
||||||
|
externalLinkIcon: false
|
||||||
|
contributors: false
|
||||||
|
changelog: false
|
||||||
|
search: false
|
||||||
|
docs:
|
||||||
|
-
|
||||||
|
name: VuePress Plume
|
||||||
|
desc: A simple, feature-rich VuePress documentation & blog theme.
|
||||||
|
logo: /plume.png
|
||||||
|
url: https://theme-plume.vuejs.press
|
||||||
|
repo: https://github.com/pengzhanbo/vuepress-theme-plume
|
||||||
|
preview: /images/demos/plume.jpg
|
||||||
|
-
|
||||||
|
name: city walk
|
||||||
|
desc: An open data platform dedicated to gathering outdoor activity locations and cultural venues from over 350 cities across the country.
|
||||||
|
logo: https://pub-187e90a3327b41ccb8869558b6b8bbc0.r2.dev/city-shenzhen/2024/12/0a08e9417033ccaf116fb71cfc7bcdb9.png
|
||||||
|
url: https://shenzhen.citywalk.group/
|
||||||
|
repo: https://github.com/sunshang-hl/CityWalk
|
||||||
|
preview: https://pub-187e90a3327b41ccb8869558b6b8bbc0.r2.dev/city-shenzhen/2024/12/ed251c4438f722dffd6cb95db86c0d56.jpg
|
||||||
|
-
|
||||||
|
name: Oh My MC
|
||||||
|
desc: Minecraft tutorial documentation.
|
||||||
|
logo: https://static.ohmymc.com/img/minecraft-154749_1280.png?max_width=1920&max_height=1920
|
||||||
|
url: https://ohmymc.com/
|
||||||
|
preview: https://static.ohmymc.com/img/20241228225159139.png?max_width=1920&max_height=1920
|
||||||
|
-
|
||||||
|
name: NcatBotDocs
|
||||||
|
desc: Documentation for NcatBot, a QQ bot framework project.
|
||||||
|
logo: https://docs.ncatbot.xyz/images/logo.png
|
||||||
|
url: https://docs.ncatbot.xyz
|
||||||
|
repo: https://github.com/Isaaczhr/NcatBotDocs
|
||||||
|
preview: https://docs.ncatbot.xyz/images/preview.jpg
|
||||||
|
-
|
||||||
|
name: PGuide Docs
|
||||||
|
desc: A localized university guide related to self-study in computer science, campus life, and open public services.
|
||||||
|
logo: https://docs.pguide.studio/logo.svg
|
||||||
|
url: https://docs.pguide.studio
|
||||||
|
repo: https://github.com/PGuideDev/PGuide-Docs
|
||||||
|
preview: https://cos-global.pguide.cloud/pguide-docs/src/pguide-doc.png
|
||||||
|
-
|
||||||
|
name: Documentation Center | Shougan Interactive
|
||||||
|
desc: Shougan Interactive is a professional platform for live questions, voting, and large-screen interactions, providing one-stop interactive solutions for lecturers, hosts, and conference organizers
|
||||||
|
logo: https://docs.shougan.net/images/logo.png
|
||||||
|
url: https://docs.shougan.net
|
||||||
|
repo: https://github.com/SuJingnan/vuepress-theme-plume
|
||||||
|
preview: https://docs.shougan.net/images/docs-proview.png
|
||||||
|
-
|
||||||
|
name: Search-Rec-Ads Cosmos Explorer
|
||||||
|
desc: Explore the fascinating universe of search, recommendation, and advertising algorithms
|
||||||
|
logo: https://raw.githubusercontent.com/1985312383/search-rec-ads-cosmos-explorer/refs/heads/main/docs/.vuepress/public/img/favicon.png
|
||||||
|
url: https://1985312383.github.io/search-rec-ads-cosmos-explorer/
|
||||||
|
repo: https://github.com/1985312383/search-rec-ads-cosmos-explorer
|
||||||
|
preview: https://raw.githubusercontent.com/1985312383/search-rec-ads-cosmos-explorer/refs/heads/main/docs/.vuepress/public/img/preview.jpg
|
||||||
|
-
|
||||||
|
name: MaaAssistantArknights Documentation Site
|
||||||
|
desc: Arknights assistant, automatic farming, smart base shifts, one-click daily tasks
|
||||||
|
logo: https://cdn.jsdelivr.net/gh/MaaAssistantArknights/design@main/logo/maa-logo_128x128.jpg
|
||||||
|
url: https://docs.maa.plus
|
||||||
|
repo: https://github.com/MaaAssistantArknights/MaaAssistantArknights/tree/dev/docs
|
||||||
|
preview: https://docs.maa.plus/images/preview.jpg
|
||||||
|
-
|
||||||
|
name: Python Beginner Docs
|
||||||
|
desc: Beginner-friendly Python 3 documentation
|
||||||
|
logo: https://python.yxzl.dev/python-logo-only.svg
|
||||||
|
url: https://python.yxzl.dev/
|
||||||
|
repo: https://github.com/yxzlwz/python-doc-web
|
||||||
|
preview: https://python.yxzl.dev/screenshot.png
|
||||||
|
-
|
||||||
|
name: TinyPiXOS
|
||||||
|
desc: A domestically developed, lightweight, and highly customizable embedded mobile device desktop OS!
|
||||||
|
logo: https://file.tinypixos.com/tinypixos/tplogo.svg
|
||||||
|
url: https://www.tinypixos.com/
|
||||||
|
repo: https://github.com/TinyPiXOS/TinyPiXOS
|
||||||
|
preview: https://file.tinypixos.com/tinypixos/plume_theme_case.jpg
|
||||||
|
-
|
||||||
|
name: HEUOpenResource
|
||||||
|
desc: Harbin Engineering University Resource Sharing Program
|
||||||
|
logo: https://cdn.jsdelivr.net/gh/HEUOpenResource/HEUOpenResource.github.io@main/docs/.vuepress/public/avatar.jpg
|
||||||
|
url: https://heu.us.kg/
|
||||||
|
repo: https://github.com/HEUOpenResource/HEUOpenResource.github.io
|
||||||
|
preview: https://cdn.jsdelivr.net/gh/HEUOpenResource/HEUOpenResource.github.io@main/docs/.vuepress/public/intro.png
|
||||||
|
-
|
||||||
|
name: SKYCRAFT Server Docs
|
||||||
|
desc: Documentation for Minecraft server SKYCRAFT.
|
||||||
|
logo: https://official.skycraft.cn/i/3.jpg
|
||||||
|
url: https://docs.skycraft.cn/
|
||||||
|
preview: https://bbsimage.skycraft.cn/docs-preview.jpg
|
||||||
|
|
||||||
|
blog:
|
||||||
|
-
|
||||||
|
name: Peng Zhanbo
|
||||||
|
desc: Even if slow, keep going; even if you fall behind, even if you fail, you must be able to reach your goal.
|
||||||
|
logo: https://pengzhanbo.cn/images/blogger-fav.png
|
||||||
|
url: https://pengzhanbo.cn/
|
||||||
|
repo: https://github.com/pengzhanbo/pengzhanbo.cn
|
||||||
|
preview: /images/demos/pengzhanbo.webp
|
||||||
|
-
|
||||||
|
name: Er Mao Zi
|
||||||
|
desc: An honest Er Mao Zi, never talks nonsense
|
||||||
|
logo: https://www.ermao.net/images/logo.svg
|
||||||
|
url: https://www.ermao.net/
|
||||||
|
repo: https://github.com/ermaozi
|
||||||
|
preview: /images/demos/ermao.net.png
|
||||||
|
-
|
||||||
|
name: Keep It Simple
|
||||||
|
desc: Entities should not be multiplied beyond necessity
|
||||||
|
logo: https://www.dingyuqi.com/icon/icon.ico
|
||||||
|
url: https://dingyuqi.com
|
||||||
|
repo: https://github.com/dingyuqi
|
||||||
|
preview: https://www.dingyuqi.com/back-ground/site-home-page.png
|
||||||
|
-
|
||||||
|
name: Tu Yongtao
|
||||||
|
desc: The farther you go in your mind, the more stable you walk in reality!
|
||||||
|
logo: http://tuyongtao.top/fettjob/imgs/head.jpg
|
||||||
|
url: http://tuyongtao.top/fettjob/
|
||||||
|
repo: https://github.com/tuyongtao-T
|
||||||
|
preview: /images/demos/tuyongtao.top.jpeg
|
||||||
|
-
|
||||||
|
name: Hoey
|
||||||
|
desc: Teacher, I really want to improve.
|
||||||
|
logo: https://zhenghaoyang.cn/avatar.jpg
|
||||||
|
url: https://zhenghaoyang.cn/
|
||||||
|
repo: https://github.com/zhenghaoyang24
|
||||||
|
preview: https://zhenghaoyang.cn/siteshot.png
|
||||||
|
-
|
||||||
|
name: IXYZ
|
||||||
|
desc: Hi, there
|
||||||
|
logo: https://ixyz.org/favicon.ico
|
||||||
|
url: https://ixyz.org
|
||||||
|
repo: https://github.com/ixyzorg
|
||||||
|
preview: /images/demos/ixyz.org.jpg
|
||||||
|
-
|
||||||
|
name: AJohn
|
||||||
|
desc: Never, ever, ever give up
|
||||||
|
logo: https://cdn.jsdelivr.net/gh/zzyAJohn/Image/blog-favicon.png
|
||||||
|
url: https://ajohn.top/
|
||||||
|
repo: https://github.com/zzyAJohn
|
||||||
|
preview: https://cdn.jsdelivr.net/gh/zzyAJohn/Image/blog-preview.png
|
||||||
|
-
|
||||||
|
name: Jiawei Wang
|
||||||
|
desc: PLUS & WAVE!
|
||||||
|
logo: https://plus-wave.github.io/icon/wave+.png
|
||||||
|
url: https://plus-wave.github.io
|
||||||
|
repo: https://github.com/PLUS-WAVE
|
||||||
|
preview: https://raw.githubusercontent.com/PLUS-WAVE/blog-image/master/img/blog/2024-11-24/plus-wave.github.io.jpg
|
||||||
|
-
|
||||||
|
name: Xiao Mu Mu Ya
|
||||||
|
desc: Life is like chess, once you make a move, you can't take it back; the way of life lies in being calm
|
||||||
|
logo: https://blog.mu00.cn/logo.png
|
||||||
|
url: https://blog.mu00.cn/
|
||||||
|
repo: https://github.com/sunnyboy-mu/sunnyboy-blog
|
||||||
|
preview: /images/demos/sunnyboy_mu.jpg
|
||||||
|
-
|
||||||
|
name: QiHuang02's Notebook
|
||||||
|
desc: Experience is the best teacher.
|
||||||
|
logo: https://qihuang02.cn/favicon.svg
|
||||||
|
url: https://qihuang02.cn/
|
||||||
|
repo: https://github.com/QiHuang02/qihuang02.github.io
|
||||||
|
preview: https://image.qihuang02.cn/file/1736003534894_yulantu.png
|
||||||
|
-
|
||||||
|
name: jiahao
|
||||||
|
desc: Just pursue it, even if it's just a momentary light
|
||||||
|
logo: https://s.jhdev.cn/head.png
|
||||||
|
url: https://jhdev.cn/
|
||||||
|
repo: https://github.com/oh-yey
|
||||||
|
preview: https://s.jhdev.cn/demos/blog-preview.png
|
||||||
|
-
|
||||||
|
name: A Zhe
|
||||||
|
desc: Strengthening yourself is the only way to solve problems
|
||||||
|
logo: https://www.azhe.xin/blogger.png
|
||||||
|
url: https://www.azhe.xin/
|
||||||
|
repo: https://github.com/liuzhemax/blog
|
||||||
|
preview: /images/demos/azhe.jpg
|
||||||
|
-
|
||||||
|
name: jindongjie
|
||||||
|
desc: Keep.It.Simple.Stupid
|
||||||
|
logo: https://ar0m.com/logo/aptrue-sience-logo.png
|
||||||
|
url: https://ar0m.com
|
||||||
|
repo: https://github.com/jindongjie/blog-vuepress-2025
|
||||||
|
preview: /images/demos/jindongjie.jpg
|
||||||
|
-
|
||||||
|
name: Yi Shu Lun
|
||||||
|
desc: A programmer's blog who loves art
|
||||||
|
logo: https://yishulun.com/avatar.png
|
||||||
|
url: https://yishulun.com
|
||||||
|
repo: https://github.com/rixingyike/rixingyike.github.io
|
||||||
|
preview: /images/demos/yishulun.com.jpg
|
||||||
|
-
|
||||||
|
name: Phys Nya
|
||||||
|
desc: Notes and life of a physics student
|
||||||
|
logo: https://physnya.top/images/Physics_nya.jpg
|
||||||
|
url: https://physnya.top
|
||||||
|
repo: https://github.com/physnya/blog
|
||||||
|
preview: https://physnya.top/images/preview.png
|
||||||
|
-
|
||||||
|
name: XINGJI
|
||||||
|
desc: All life so far has been written with failure, but that doesn't stop me from moving forward✨
|
||||||
|
logo: https://i.p-i.vip/47/20240920-66ed7b168c38c.jpg
|
||||||
|
url: https://vue.xingji.fun
|
||||||
|
repo: https://github.com/XingJi-love/XingJi-blog-plume
|
||||||
|
preview: https://i.p-i.vip/47/20250407-67f3f1eca1983.png
|
||||||
|
-
|
||||||
|
name: Paiad
|
||||||
|
desc: Pessimists are always right, optimists always move forward.
|
||||||
|
logo: https://blog.paiad.top/sunflower.png
|
||||||
|
url: https://blog.paiad.top
|
||||||
|
repo: https://github.com/paiad
|
||||||
|
preview: https://blog.paiad.top/paiad-blog.png
|
||||||
|
-
|
||||||
|
name: Flash
|
||||||
|
desc: The road ahead is long; I shall search up and down
|
||||||
|
logo: https://haipeng-lin.cn/images/avatar.jpg
|
||||||
|
url: https://haipeng-lin.cn
|
||||||
|
repo: https://gitee.com/linhaipengg
|
||||||
|
preview: https://img.haipeng-lin.cn/1768622018580.png
|
||||||
|
-
|
||||||
|
name: PinkDopeyBug
|
||||||
|
desc: Mountains are hard to see floating rafts, hearts easily fall into mirror flowers.
|
||||||
|
logo: https://w20241204.dpdns.org/images/avatar.jpg
|
||||||
|
url: https://w20241204.dpdns.org/
|
||||||
|
repo: https://github.com/PinkDopeyBug/blog
|
||||||
|
preview: https://w20241204.dpdns.org/images/demos/preview.png
|
||||||
|
-
|
||||||
|
name: rand777
|
||||||
|
desc: Even wobbly, you can reach your destination.
|
||||||
|
logo: https://blog.rand777.space/avatar.jpg
|
||||||
|
url: https://blog.rand777.space
|
||||||
|
repo: https://github.com/rand777gg/rand777-plume-blog
|
||||||
|
preview: https://blog.rand777.space/siteshot.png
|
||||||
|
-
|
||||||
|
name: Yi Xiang Zhi Lu
|
||||||
|
desc: Yi Xiang Zhi Lu's Blog
|
||||||
|
logo: https://yxzl.dev/head.png
|
||||||
|
url: https://yxzl.dev/
|
||||||
|
repo: https://github.com/yxzlwz/blog
|
||||||
|
preview: https://yxzl.dev/screenshot.png
|
||||||
|
-
|
||||||
|
name: Honahec
|
||||||
|
desc: Honahec's Blog
|
||||||
|
logo: https://image.honahec.cc/avatar-circle.png
|
||||||
|
url: https://blog.honahec.cc/
|
||||||
|
repo: https://github.com/Honahec/blog
|
||||||
|
preview: https://image.honahec.cc/20251018223321710.png
|
||||||
|
-
|
||||||
|
name: Lucas
|
||||||
|
desc: Ad astra abyssosque.
|
||||||
|
logo: https://static.lucas04.top/static/favicon/favicon-64.png
|
||||||
|
url: https://blog.lucas04.top/
|
||||||
|
repo: https://github.com/lucas0-nhr/lucas04-nhr.github.io
|
||||||
|
preview: https://static.lucas04.top/static/blog_preview.png
|
||||||
|
-
|
||||||
|
name: Kairui's Website
|
||||||
|
desc: Mathematics is the art of expressing ideas precisely.
|
||||||
|
logo: https://kairui.ca/uoft.svg
|
||||||
|
url: https://kairui.ca
|
||||||
|
repo: https://github.com/orderization
|
||||||
|
preview: https://kairui.ca/img/homepage_demo.png
|
||||||
|
-
|
||||||
|
name: Konata's Secret Base
|
||||||
|
desc: A private space to record technology and life
|
||||||
|
logo: https://raw.githubusercontent.com/Konata9/pic-base/main/pics/20260126223726455.png
|
||||||
|
url: https://konata9.cc/
|
||||||
|
preview: https://raw.githubusercontent.com/Konata9/pic-base/main/pics/20260125225910673.webp
|
||||||
|
---
|
||||||
|
|
||||||
|
:::important
|
||||||
|
You can always add your documentation or blog to this page via ==PR==.
|
||||||
|
|
||||||
|
Site preview images should be placed in the `docs/.vuepress/public/images/demos` directory. Using remote links is recommended so you can update them at any time.
|
||||||
|
|
||||||
|
Please try to use `.jpg` format for images, and use [tinypng](https://tinypng.com/) for compression if the file size is large.
|
||||||
|
:::
|
||||||
|
|
||||||
|
[Go to **Github Pull Request** to submit your site](https://github.com/pengzhanbo/vuepress-theme-plume/edit/main/docs/en/demos.md){.read-more}
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
<Demos :list="$frontmatter.docs" />
|
||||||
|
|
||||||
|
## Blog
|
||||||
|
|
||||||
|
<Demos :list="$frontmatter.blog" />
|
||||||
|
|
||||||
|
<script setup>
|
||||||
|
import Demos from '~/components/Demos.vue'
|
||||||
|
</script>
|
||||||
@ -2,6 +2,7 @@
|
|||||||
title: Frequently Asked Questions
|
title: Frequently Asked Questions
|
||||||
createTime: 2025/10/08 08:47:36
|
createTime: 2025/10/08 08:47:36
|
||||||
permalink: /en/faq/
|
permalink: /en/faq/
|
||||||
|
article: false
|
||||||
---
|
---
|
||||||
|
|
||||||
This document primarily covers common issues and solutions you might encounter while using the theme.
|
This document primarily covers common issues and solutions you might encounter while using the theme.
|
||||||
@ -85,3 +86,104 @@ files (like `package-lock.json` or `pnpm-lock.yaml`) might be corrupted.
|
|||||||
|
|
||||||
Please directly delete the dependency lock files (`package-lock.json`, `pnpm-lock.yaml`, etc.)
|
Please directly delete the dependency lock files (`package-lock.json`, `pnpm-lock.yaml`, etc.)
|
||||||
and the `node_modules` directory, then reinstall the dependencies.
|
and the `node_modules` directory, then reinstall the dependencies.
|
||||||
|
|
||||||
|
## How to hide the page footer?
|
||||||
|
|
||||||
|
You can hide the footer by adding `footer: false` in the frontmatter of the Markdown file.
|
||||||
|
|
||||||
|
```md title="post.md"
|
||||||
|
---
|
||||||
|
footer: false
|
||||||
|
---
|
||||||
|
|
||||||
|
content
|
||||||
|
```
|
||||||
|
|
||||||
|
[Configuration Documentation: **frontmatter > Footer**](../config/frontmatter/basic.md#footer){.read-more}
|
||||||
|
|
||||||
|
Or you can hide the footer for all pages on the main site by adding `footer: false` in the theme configuration file.
|
||||||
|
|
||||||
|
```ts title=".vuepress/config.ts"
|
||||||
|
export default defineUserConfig({
|
||||||
|
theme: plumeTheme({
|
||||||
|
footer: false, // [!code ++]
|
||||||
|
})
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
[Configuration Documentation: **Theme Configuration**](../config/theme.md#footer){.read-more}
|
||||||
|
|
||||||
|
## Build error: `JavaScript heap out of memory`
|
||||||
|
|
||||||
|
When executing `npm run docs:build`, you encounter an error similar to:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
<--- Last few GCs --->
|
||||||
|
|
||||||
|
[69161:0x7fe63aa00000] 137006 ms: xxxxxx
|
||||||
|
[69161:0x7fe63aa00000] 139327 ms: xxxxxxxx
|
||||||
|
|
||||||
|
<--- JS stacktrace --->
|
||||||
|
FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory
|
||||||
|
----- Native stack trace -----
|
||||||
|
|
||||||
|
1: 0x107ce7c84 xxxxxxxxxxxx
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
This is due to insufficient Node.js memory.
|
||||||
|
|
||||||
|
Modify the Node.js memory limit by adding the following environment variables:
|
||||||
|
|
||||||
|
**Method 1: In the current terminal session**:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
export NODE_OPTIONS="--max_old_space_size=8192"
|
||||||
|
npm run docs:build
|
||||||
|
```
|
||||||
|
|
||||||
|
==Note that this method is only effective for the current terminal session.=={.warning}
|
||||||
|
|
||||||
|
**Method 2: In the local environment**:
|
||||||
|
|
||||||
|
If you need to keep this environment variable long-term, you can modify the Node.js memory limit in your local environment:
|
||||||
|
|
||||||
|
:::: steps
|
||||||
|
|
||||||
|
- Install `cross-env` in your project
|
||||||
|
|
||||||
|
::: npm-to
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm install -D cross-env
|
||||||
|
```
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
- Add `scripts` in `package.json`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"scripts": {
|
||||||
|
"docs:build-local": "cross-env NODE_OPTIONS=\"--max_old_space_size=8192\" vuepress build docs --clean-cache --clean-temp"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
::::
|
||||||
|
|
||||||
|
When building locally, use `npm run docs:build-local` to build the package.
|
||||||
|
|
||||||
|
**Method 3: In GitHub Actions**:
|
||||||
|
|
||||||
|
Modify the `.github/workflows/deploy.yml` file and add the following environment variables:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# ...
|
||||||
|
- name: Build VuePress site
|
||||||
|
env: # [!code ++:2]
|
||||||
|
NODE_OPTIONS: --max_old_space_size=8192
|
||||||
|
run: npm run docs:build
|
||||||
|
|
||||||
|
# ...
|
||||||
|
```
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user