vuepress-theme-plume/assets/README-BooGM4yT.js

1 line
13 KiB
JavaScript

import{$ as e,B as t,P as n,_ as r,_t as i,f as a,g as o,h as s,l as c}from"./runtime-core.esm-bundler-CZvn3YaB.js";import{n as l,t as u}from"./contributors-DbbJhHOj.js";var d={style:{"max-width":`960px`,margin:`0 auto`},class:`home-custom-content`},f=JSON.parse(`{"path":"/en/","title":"Vuepress Theme Plume","lang":"en-US","frontmatter":{"pageLayout":"home","title":"Vuepress Theme Plume","config":[{"type":"hero","full":true,"effect":"hyper-speed","forceDark":true,"hero":{"name":"Theme Plume","tagline":"VuePress Next Theme","text":"A simple, easy-to-use, feature-rich VuePress documentation & blog theme","actions":[{"theme":"brand","text":"Get Started →","link":"/en/guide/intro/"},{"theme":"alt","text":"Github","link":"https://github.com/pengzhanbo/vuepress-theme-plume"}]}},{"type":"features","features":[{"title":"Responsive Layout","icon":"twemoji:laptop-computer","details":"Adapts to mobile devices, PCs, and tablets"},{"title":"Blog & Documentation","icon":"twemoji:open-book","details":"Whether you want to write a blog, product documentation, or both"},{"title":"Out-of-the-Box","icon":"twemoji:rocket","details":"Supports zero-configuration out-of-the-box, as well as rich customization options"},{"title":"Multi-language","icon":"twemoji:balance-scale","details":"Built-in support for 7 languages including Chinese and English, and you can customize and add more language support"},{"title":"Dual Color Theme","icon":"twemoji:cityscape","details":"Supports light/dark themes, including code highlighting"},{"title":"Plugins","icon":"twemoji:card-file-box","details":"Built-in rich plugins to meet general website needs"},{"title":"Search & Comments","icon":"twemoji:magnifying-glass-tilted-right","details":"Supports multiple comment systems, local search, and Algolia search"},{"title":"Encryption","icon":"twemoji:locked-with-key","details":"Supports full-site encryption and partial encryption (encrypted directories, encrypted articles)"},{"title":"Markdown Enhancement","icon":"twemoji:writing-hand-light-skin-tone","details":"Based on regular markdown syntax, adds dozens of enhanced syntaxes such as custom containers, file trees, code groups, etc."}]},{"type":"image-text","title":"Features","description":"Built-in rich features to meet general website needs.","image":"/images/plume-1.svg","list":[{"title":"Article Information","description":"Add tags, categories, word count, reading time, writing date, and other information to articles."},{"title":"Comments","description":"Supports 4 comment systems: Giscus, Waline, Twikoo, Artalk<br>You can freely choose the comment system that suits your needs."},{"title":"Search","description":"Supports local search based on minisearch, and also supports Algolia search."},{"title":"Encryption","description":"Supports full-site encryption and partial encryption (encrypted directories, encrypted articles)."},{"title":"Code","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","description":"Charts: chart.js/ECharts/Mermaid/flowchart<br>Videos: Bilibili/Youtube/ArtPlayer<br>PDF, 200K+ Iconify icons"}]},{"type":"text-image","title":"Blog","description":"The theme supports blogs by default, allowing you to create your personal blog.","image":"/images/plume-2.svg","list":[{"title":"Article List","description":"Automatically sorts and generates a blog article list page based on the article writing date."},{"title":"Blogger Information","description":"Customize name, motto, avatar, and social media links."},{"title":"Categories, Tags, Archives","description":"Automatically generates category pages, tag pages, and archives articles by year."}]},{"type":"image-text","title":"Documentation","image":"/images/plume-3.svg","description":"The theme supports documentation by default, allowing you to create product documentation or organize your knowledge system.","list":[{"title":"Sidebar","description":"Automatically generates a sidebar based on the documentation directory, or you can manually configure it. The theme provides a simpler configuration method."},{"title":"Documentation Classification","description":"You can categorize different documents into different directories for better management of the documentation structure."}]},{"type":"custom"}],"description":"GitHub Repo stars npm version npm downloads npm downloads github license peer dependency codecov Usage Use the following command to quickly create a new VuePress project using t...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Vuepress Theme Plume\\",\\"image\\":[\\"https://img.shields.io/github/stars/pengzhanbo/vuepress-theme-plume\\",\\"https://img.shields.io/npm/v/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=npm\\",\\"https://img.shields.io/npm/dm/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=downloads\\",\\"https://img.shields.io/npm/dt/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=downloads\\",\\"https://img.shields.io/github/license/pengzhanbo/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A\\",\\"https://img.shields.io/npm/dependency-version/vuepress-theme-plume/peer/vuepress?color=32A9C3&labelColor=1B3C4A\\",\\"https://codecov.io/gh/pengzhanbo/vuepress-theme-plume/graph/badge.svg?token=W6KYBX7WO5\\"],\\"dateModified\\":null,\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://theme-plume.vuejs.press/en/"}],["meta",{"property":"og:site_name","content":"Plume Theme"}],["meta",{"property":"og:title","content":"Vuepress Theme Plume"}],["meta",{"property":"og:description","content":"GitHub Repo stars npm version npm downloads npm downloads github license peer dependency codecov Usage Use the following command to quickly create a new VuePress project using t..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:image","content":"https://img.shields.io/github/stars/pengzhanbo/vuepress-theme-plume"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://theme-plume.vuejs.press/"}]]},"readingTime":{"minutes":2.24,"words":673},"git":{},"autoDesc":true,"filePathRelative":"en/README.md","headers":[],"bulletin":false}`),p=Object.assign({name:`README.md`},{setup(f){return(f,p)=>{let m=t(`VPIcon`),h=t(`CodeTabs`),g=t(`VPLink`);return n(),a(`div`,null,[c(`div`,d,[p[13]||=s(`<div style="text-align:center;"><p><img src="https://img.shields.io/github/stars/pengzhanbo/vuepress-theme-plume" alt="GitHub Repo stars" class="no-view"><img src="https://img.shields.io/npm/v/vuepress-theme-plume?color=32A9C3&amp;labelColor=1B3C4A&amp;label=npm" alt="npm version" class="no-view"><img src="https://img.shields.io/npm/dm/vuepress-theme-plume?color=32A9C3&amp;labelColor=1B3C4A&amp;label=downloads" alt="npm downloads" class="no-view"><img src="https://img.shields.io/npm/dt/vuepress-theme-plume?color=32A9C3&amp;labelColor=1B3C4A&amp;label=downloads" alt="npm downloads" class="no-view"><img src="https://img.shields.io/github/license/pengzhanbo/vuepress-theme-plume?color=32A9C3&amp;labelColor=1B3C4A" alt="github license" class="no-view"></p><p><img src="https://img.shields.io/npm/dependency-version/vuepress-theme-plume/peer/vuepress?color=32A9C3&amp;labelColor=1B3C4A" alt="peer dependency" class="no-view"><img src="https://codecov.io/gh/pengzhanbo/vuepress-theme-plume/graph/badge.svg?token=W6KYBX7WO5" alt="codecov" class="no-view" width="122" height="20"></p></div><h3 id="usage" tabindex="-1"><a class="header-anchor" href="#usage"><span>Usage</span></a></h3><p>Use the following command to quickly create a new <mark>VuePress</mark> project using this theme.</p>`,3),r(h,{id:`0`,data:[{id:`pnpm`},{id:`yarn`},{id:`npm`}],"tab-id":`npm-to-pnpm-yarn-npm`},{title0:e(({value:e,isActive:t})=>[r(m,{provider:`iconify`,name:`vscode-icons:file-type-light-pnpm`}),p[0]||=c(`span`,null,`pnpm`,-1)]),title1:e(({value:e,isActive:t})=>[r(m,{provider:`iconify`,name:`vscode-icons:file-type-yarn`}),p[1]||=c(`span`,null,`yarn`,-1)]),title2:e(({value:e,isActive:t})=>[r(m,{provider:`iconify`,name:`logos:npm-icon`}),p[2]||=c(`span`,null,`npm`,-1)]),tab0:e(({value:e,isActive:t})=>[...p[3]||=[c(`div`,{class:`language-sh`,"data-highlighter":`shiki`,"data-ext":`sh`,style:{"--shiki-light":`#393a34`,"--shiki-dark":`#dbd7caee`,"--shiki-light-bg":`#ffffff`,"--shiki-dark-bg":`#121212`}},[c(`pre`,{class:`shiki shiki-themes vitesse-light vitesse-dark vp-code`},[c(`code`,{class:`language-sh`},[c(`span`,{class:`line`},[c(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},`pnpm`),c(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},` create`),c(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},` vuepress-theme-plume@latest`)])])])],-1)]]),tab1:e(({value:e,isActive:t})=>[...p[4]||=[c(`div`,{class:`language-sh`,"data-highlighter":`shiki`,"data-ext":`sh`,style:{"--shiki-light":`#393a34`,"--shiki-dark":`#dbd7caee`,"--shiki-light-bg":`#ffffff`,"--shiki-dark-bg":`#121212`}},[c(`pre`,{class:`shiki shiki-themes vitesse-light vitesse-dark vp-code`},[c(`code`,{class:`language-sh`},[c(`span`,{class:`line`},[c(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},`yarn`),c(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},` create`),c(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},` vuepress-theme-plume@latest`)])])])],-1)]]),tab2:e(({value:e,isActive:t})=>[...p[5]||=[c(`div`,{class:`language-sh`,"data-highlighter":`shiki`,"data-ext":`sh`,style:{"--shiki-light":`#393a34`,"--shiki-dark":`#dbd7caee`,"--shiki-light-bg":`#ffffff`,"--shiki-dark-bg":`#121212`}},[c(`pre`,{class:`shiki shiki-themes vitesse-light vitesse-dark vp-code`},[c(`code`,{class:`language-sh`},[c(`span`,{class:`line`},[c(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},`npm`),c(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},` create`),c(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},` vuepress-theme-plume@latest`)])])])],-1)]]),_:1}),p[14]||=c(`h3`,{id:`start-the-project`,tabindex:`-1`},[c(`a`,{class:`header-anchor`,href:`#start-the-project`},[c(`span`,null,`Start the project`)])],-1),r(h,{id:`0`,data:[{id:`pnpm`},{id:`yarn`},{id:`npm`}],"tab-id":`npm-to-pnpm-yarn-npm`},{title0:e(({value:e,isActive:t})=>[r(m,{provider:`iconify`,name:`vscode-icons:file-type-light-pnpm`}),p[6]||=c(`span`,null,`pnpm`,-1)]),title1:e(({value:e,isActive:t})=>[r(m,{provider:`iconify`,name:`vscode-icons:file-type-yarn`}),p[7]||=c(`span`,null,`yarn`,-1)]),title2:e(({value:e,isActive:t})=>[r(m,{provider:`iconify`,name:`logos:npm-icon`}),p[8]||=c(`span`,null,`npm`,-1)]),tab0:e(({value:e,isActive:t})=>[...p[9]||=[c(`div`,{class:`language-sh`,"data-highlighter":`shiki`,"data-ext":`sh`,style:{"--shiki-light":`#393a34`,"--shiki-dark":`#dbd7caee`,"--shiki-light-bg":`#ffffff`,"--shiki-dark-bg":`#121212`}},[c(`pre`,{class:`shiki shiki-themes vitesse-light vitesse-dark vp-code`},[c(`code`,{class:`language-sh`},[c(`span`,{class:`line`},[c(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},`pnpm`),c(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},` docs:dev`)])])])],-1)]]),tab1:e(({value:e,isActive:t})=>[...p[10]||=[c(`div`,{class:`language-sh`,"data-highlighter":`shiki`,"data-ext":`sh`,style:{"--shiki-light":`#393a34`,"--shiki-dark":`#dbd7caee`,"--shiki-light-bg":`#ffffff`,"--shiki-dark-bg":`#121212`}},[c(`pre`,{class:`shiki shiki-themes vitesse-light vitesse-dark vp-code`},[c(`code`,{class:`language-sh`},[c(`span`,{class:`line`},[c(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},`yarn`),c(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},` docs:dev`)])])])],-1)]]),tab2:e(({value:e,isActive:t})=>[...p[11]||=[c(`div`,{class:`language-sh`,"data-highlighter":`shiki`,"data-ext":`sh`,style:{"--shiki-light":`#393a34`,"--shiki-dark":`#dbd7caee`,"--shiki-light-bg":`#ffffff`,"--shiki-dark-bg":`#121212`}},[c(`pre`,{class:`shiki shiki-themes vitesse-light vitesse-dark vp-code`},[c(`code`,{class:`language-sh`},[c(`span`,{class:`line`},[c(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},`npm`),c(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},` run`),c(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},` docs:dev`)])])])],-1)]]),_:1}),p[15]||=c(`h3`,{id:`changelog`,tabindex:`-1`},[c(`a`,{class:`header-anchor`,href:`#changelog`},[c(`span`,null,`Changelog`)])],-1),c(`p`,null,[r(g,{href:`./changelog`},{default:e(()=>[...p[12]||=[o(`Changelog`,-1)]]),_:1})]),p[16]||=c(`h3`,{id:`contributors`,tabindex:`-1`},[c(`a`,{class:`header-anchor`,href:`#contributors`},[c(`span`,null,`Contributors`)])],-1),p[17]||=c(`p`,null,`Thanks to all contributors!`,-1),r(l,{contributors:i(u)},null,8,[`contributors`])])])}}});export{f as _pageData,p as default};