Skip to content

🎉 A Simple VitePress Theme | 一个极简的 VitePress 主题

License

Notifications You must be signed in to change notification settings

gfjz/vitepress-theme-curve

 
 

Repository files navigation

Curve

A Simple VitePress Theme

curve-logo


Preview: 👻 無名小栈

Docs: 📖 主题文档

Note

该主题本意为自用,所以部分配置可能并不完善,包括评论系统的支持,目前仅支持 Artalk,如有其他需求,可提交 pr

Hello

🎉 你好啊,很高兴你选择了 vitepress-theme-curve,你可以查看 主题文档 以了解更多,如果你在使用本主题时遇到问题,你可以在 GitHub 中正确的提交 issues 以获取社区的帮助。

快速开始

若您有修改主题的需求,请确保您拥有基础的前端知识,最好能掌握 Vue.js 框架的相关知识,并确保阅读了 VitePress官方文档

书写新的文章

你可以直接在站点根目录中的 posts 文件夹中直接新建 markdown 文件来书写,您的文件路径即为实际生成的网址路径。

添加新的页面

你可以直接在站点根目录中的 pages 文件夹中直接新建 markdown 文件来实现新建页面,您的文件路径即为实际生成的网址路径。

主题中已经内置了几个常用页面以供参考。

主题配置

本主题提供了一个 themeConfig.mjs 文件用来配置,它位于 .vitepress\theme\assets\themeConfig.mjs,你可以将它复制一份并移动至根目录中,在这里里面的修改将会覆盖初始配置,请注意,请不要更改文件名或者删除原配置文件,否则它将会不起作用!

静态文件

通常情况下,静态文件处于根目录下的 public 文件夹中,通常用于存放字体或图片等文件信息。

了解更多:资源处理

部署

如果你之前使用过类似于 Hexo 一样的静态站点生成器的话,那么这二者是极为相似的,都是构建为静态文件后上传至服务器以实现访问,当然,你也可以借助 GitHub 的 Actions 以实现自动部署,具体细节请参考我的博客,此处不再细说。

# 安装依赖
npm run install
# 构建
npm run build

建议使用 pnpm,若未安装,可使用 npm install pnpm -g 来安装。

pnpm install
pnpm build

通常在未修改配置文件的情况下,打包后的文件会处于根目录下的 .vitepress\dist 目录中,您可以将其中的文件上传至任意服务器以访问。

更多

更多信息请参考:主题文档

Powered by VitePress

Netlify Status

About

🎉 A Simple VitePress Theme | 一个极简的 VitePress 主题

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Vue 71.5%
  • JavaScript 18.8%
  • SCSS 7.1%
  • HTML 2.6%