https://github.com/project-trans/vitepress-theme-project-trans
这是一个由 Project Trans 开发的 VitePress 主题。
https://github.com/project-trans/vitepress-theme-project-trans
documentation theme vitepress vitepress-theme vue
Last synced: about 1 month ago
JSON representation
这是一个由 Project Trans 开发的 VitePress 主题。
- Host: GitHub
- URL: https://github.com/project-trans/vitepress-theme-project-trans
- Owner: project-trans
- License: mit
- Created: 2024-09-16T14:22:49.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-25T04:44:21.000Z (7 months ago)
- Last Synced: 2024-10-26T07:28:10.927Z (7 months ago)
- Topics: documentation, theme, vitepress, vitepress-theme, vue
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@project-trans/vitepress-theme-project-trans
- Size: 229 KB
- Stars: 9
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VitePress Theme Project Trans
这是一个由 Project Trans 开发的 VitePress 主题。
[构建效果](https://rle.wiki/)
## 使用方式
修改下述两个文件：
```typescript
// docs/.vitepress/config.ts
import type { SidebarOptions } from '@project-trans/vitepress-theme-project-trans/theme'
import type { ThemeContext } from '@project-trans/vitepress-theme-project-trans/utils'
import genConfig from '@project-trans/vitepress-theme-project-trans/config'
import { withThemeContext } from '@project-trans/vitepress-theme-project-trans/utils'
const themeConfig: ThemeContext = {
siteTitle: 'RLE.wiki',
siteDescription: '一份 RLE 指北',
/** Repo */
githubRepoLink: 'https://github.com/project-trans/RLE-wiki',
/** vitepress 根目录 */
rootDir: 'docs',
/** 文档所在目录（目前似未使用此项） */
include: ['campus', 'contributor-guide', 'fashion'],
nav,
sidebarOptions,
}
// https://vitepress.dev/reference/site-config
export default withThemeContext(themeConfig, genConfig)
```
```typescript
// docs/.vitepress/theme/index.ts
// https://vitepress.dev/guide/custom-theme
import PtjsTheme from '@project-trans/vitepress-theme-project-trans/theme'
import 'uno.css'
import './style.css'
export default {
extends: PtjsTheme,
}
```
## 调试说明
1. 修改文件后在仓库根目录下进行构建
- `pnpm i`
- `pnpm build`
2. 切换到 example 路径下预览
- `cd example`
- `pnpm dev`