开发指南
开发指南 开发环境 | 类型 | 名称 | 版本 | | :------------ | :---------------- | :--------------- | | 操作系统 | Windows 11 专业版 | 26100.3476 | | 开发工具 | Microsoft VS Code | 1.96.2 | | 调试工具 | Microsoft Edge |...
01.指南
2025年9月28日
浏览量：--
共找到 17 篇文章
显示 17 / 17 篇文章
私密文章
私密文章 私密文章需要一个登录页进行登录，如果你想先体验登录页的效果，在导航栏 功能页 -> 登录页 点击查看。 您也可以通过 teek-login-page 插槽自定义登录页。 `vue import Teek from "vitepress-theme-teek"; import Your Login Page Component from "./Your Login Page...
站点统计
站点统计 Teek 集成了三种常见的站点统计工具： - 百度分析 Baidu Analytics - 谷歌分析 Google Analytics - Umami 分析 让你可以轻松地在 Vite Press 网站中集成并管理这些分析工具。无论是谷歌分析的强大功能，还是百度统计对中国市场的适配，或者是 Umami 的隐私友好型方案，都可以通过这个插件快速集成并使用。 百度统计 `ts //...
路由钩子
路由钩子 Vite Press 提供的 use Router 有 4 个路由钩子，分别为： - on Before Route Change：路由变化前触发，如果在该钩子函数中返回 false，则不会进行路由跳转 - on Before Page Load：页面加载前执行，在 on Before Route Change 之后触发，如果在该钩子函数中返回 false，则不会进行路由跳转 - on...
贡献指南
感谢您使用 Teek。 以下是关于向 Teek 提交反馈或代码的指南。在向 Teek 提交 Issue 或者 PR 之前，请先花几分钟时间阅读以下内容。 Issue 规范 - 遇到问题时，请先确认这个问题是否已经在 Issue 中有记录或者已被修复 - 提 Issue 时，请用简短的语言描述遇到的问题，并添加出现问题时的环境和复现步骤，必要时需提供可复现问题最小代码仓库 环境包含 - 浏览器...
鸣谢
鸣谢 本文记录 Teek 在成长过程中帮忙测试、开发的小伙伴们，以及 Teek 参考的其他优质 Vite Press、Vue Press 主题，感谢你们让 Teek 更加优秀。 主题 Teek 的灵感主要来自于 vuepress-theme-vdoing，在 Vite Press 没有出来之前，Teek 使用 vuepress-theme-vdoing 搭建的博客站，因此 Teek 含有...
样式增强
样式增强 Teek 提供了一些样式文件来加强 Vite Press 和 Teek 的样式，比如： > Vite Press 文档风格首页添加彩色渐变动画、文章一级标题添加渐变色、Banner 描述添加渐变效果、侧边栏标题组字号加粗等。 > Teek 首页 Banner 描述添加渐变效果、首页 Banner 壁纸添加缩放动画等 这些样式文件并不会直接生效，您需要手动引入这些文件。 Vite...
插槽布局
插槽布局 Teek 提供了很多的插槽，能够被用来在页面的特定位置注入内容，下面这个例子展示了将一个组件注入到首页右侧卡片栏底部： `ts // .vitepress/theme/index.ts import Teek from "vitepress-theme-teek"; import My Layout from "./My Layout.vue"; import...
摘要与封面
摘要与封面 首页的文章列表中，可以显示文章摘要和封面图。 文章摘要 文章摘要的设置有三种方式： - 使用 frontmatter.description 属性 - 使用 注释 - 使用 post.show Capture 属性 如果三种方式都设置，只有一种生效，优先级为：使用 frontmatter.description 属性 > 使用 注释 > 使用 post.show Capture 属性...
主题增强
主题增强 Teek 内置了 4 种布局模式、8 种主题风格可供切换，请将鼠标移到右上角的主题增强面板进行体验。 布局模式 4 种布局模式分别为： - full Width：全部展开，使侧边栏和内容区域占据整个屏幕的全部宽度 - sidebar Width Adjustable Only：全部展开，侧边栏宽度可调，但内容区域宽度不变，调整后的侧边栏将可以占据整个屏幕的最大宽度 - both...
写作排版
写作排版 ::: tip 序言 统一中文文案、排版的相关用法，降低团队成员之间的沟通成本，增强网站气质 ::: 空格 「有研究显示，打字的时候不喜欢在中文和英文之间加空格的人，感情路都走得很辛苦，有七成的比例会在 34 岁的时候跟自己不爱的人结婚，而其余三成的人最后只能把遗产留给自己的猫。毕竟爱情跟书写都需要适时地留白。 与大家共勉之。 ::: right ——...
国际化
国际化 Teek 默认使用中文，如果你希望使用其他语言，你可以参考下面的方案。 全局语言配置 在 Teek. Layout 组件传入 locale 参数，即可设置默认语言。 `ts // .vitepress/config.mts import Teek, { en } from "vitepress-theme-teek"; import...
简介
简介 Teek 是一个轻量、简洁高效、灵活配置、易于扩展的 Vite Press 主题 ✨，是在默认主题的基础上进行拓展，支持 Vite Press 的所有功能、配置，完全可以零成本迁移过来。 使用 Teek 可以很方便的搭建一个结构化的知识库或博客。 ::: warning - Node.js 18.0.0 及以上版本 - 在使用 Teek 前，要求至少会 Vite Press...
快速开始
快速开始 版本 Teek badge 建议使用如下包管理器安装 vitepress-theme-teek： - pnpm - yarn - npm Vite Press 安装 有关 Vite Press 的安装教程来源于 Vite Press 文档。如果安装失败，请阅读 Vite Press 文档查看最新的安装教程。 ::: code-group `sh [pnpm] pnpm add -D...
结构化目录
结构化目录 目录结构 在运行或构建 Teek 时，Teek 会按照目录结构自动生成一个结构化的 侧边栏、目录树、面包屑、文章列表、文章分析 等数据。 侧边栏和目录树的标题获取有如下特性： - 针对文件夹，先分别扫描该文件夹下的 index.md、index. MD、[文件夹名].md 文件，并尝试获取里面的一级标题，如果获取到一级标题，则使用，否则使用文件夹名 - 针对 Markdown...
Markdown 拓展
Markdown 拓展 Vite Press 使用 markdown-it 来对 Markdown 进行解析和渲染，最终转为 Vue 组件。 markdown-it 是一款功能强大的 Markdown 解析器，支持丰富的 Markdown 语法，能够轻松将 Markdown 文本转换为 HTML 格式，并提供了许多语法扩展和插件。如果希望文章页拓展一些新的功能、UI，那么可以利用它拦截并处理...
Vite 插件
Vite 插件 Vite Press 是基于 Vite 进行搭建，因此可以编写 Vite 插件来辅助完成一些在无法在浏览器环境完成的动作，比如在 Vite Press 启动后，扫描文档目录下的 Markdown 文件，提取 frontmatter 的信息进行分析，或在渲染 Markdown 内容前，对其进行加工。 得益于 Vite 环境，Teek 内置了一些 Vite 插件来执行在 Node...