Skip to content

Commit 1ebd3cf

Browse files
committed
feat: home page style has been significantly updated
1 parent ff0dd34 commit 1ebd3cf

File tree

18 files changed

+2186
-1205
lines changed

18 files changed

+2186
-1205
lines changed

README.md

Lines changed: 8 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -1,131 +1,11 @@
1-
<p align="center">
2-
Valaxy-Theme-Oceanus<sup><em>(vue)</em></sup>
3-
</p>
4-
5-
[![npm](https://img.shields.io/npm/v/valaxy-theme-starter)](https://www.npmjs.com/package/valaxy-theme-starter)
6-
[![npm dev dependency version](https://img.shields.io/npm/dependency-version/valaxy-theme-starter/dev/valaxy)](https://github.com/YunYouJun/valaxy)
7-
8-
> This is a template for creating a [valaxy](https://github.com/YunYouJun/valaxy) theme.
9-
10-
## Usage
11-
12-
### Clone to local
13-
14-
> Use [pnpm](https://pnpm.io/), because we need its workspace.
15-
16-
```bash
17-
npx degit YunYouJun/valaxy-theme-starter valaxy-theme-name
18-
19-
cd valaxy-theme-name
20-
21-
# If you don't have pnpm installed
22-
npm install -g pnpm
23-
24-
pnpm i
25-
```
26-
27-
### Development
28-
29-
```bash
30-
# dev node
31-
pnpm dev
32-
# dev client
33-
pnpm demo
34-
```
35-
36-
### Build
37-
38-
```bash
39-
pnpm build
40-
```
41-
42-
### Release
43-
44-
> Publish to [npm](https://www.npmjs.com/).
45-
46-
#### Manual
47-
48-
```bash
49-
pnpm ci:publish
50-
```
51-
52-
#### Auto by GitHub Actions
53-
54-
> You can release it by github actions.
55-
56-
Click `Settings` -> `Secrets` -> `Actions` in your GitHub repo.
57-
58-
Add `New repository secret`:
59-
60-
- `NPM_TOKEN`: `your npm token` (Generate from your npm `Access Tokens` - `Automation`)
61-
62-
```bash
63-
npm run release
64-
# choose your version to automatic release
65-
```
66-
67-
## Checklist
68-
69-
- [ ] Change the author name in `LICENSE` & `package.json` & `.github`
70-
- [ ] Write `ThemeConfig` & Other init content
71-
- [ ] Rename `valaxy-theme-starter` to `valaxy-theme-<name>` (custom it)
72-
- [ ] Change `theme: 'starter'` to `theme: <name>` in `valaxy.config.ts`
73-
- [ ] Each of your Vue components should have a namespace
74-
- For example: `YunTest.vue` for `valaxy-theme-yun`
75-
76-
### About Checklist Rename
77-
78-
Rename `valaxy-theme-starter` with `valaxy-theme-name` in the `package.json` and `valaxy.config.ts` files.
79-
80-
PS: there are a total of four files that need to be rename
81-
82-
```bash
83-
valaxy-theme-name
84-
- package.json
85-
- demo
86-
- package.json
87-
- valaxy.config.ts
88-
- theme
89-
- package.json
90-
```
91-
92-
Let's write the theme & docs!
93-
94-
## Thanks
95-
96-
Starter theme ref theme:
97-
98-
- [vuejs/blog](https://github.com/vuejs/blog)
99-
- [tailwind-nextjs-starter-blog](https://github.com/timlrx/tailwind-nextjs-starter-blog)
100-
101-
### [Sponsors](https://sponsors.yunyoujun.cn)
1+
<h1 align="center">valaxy-theme-oceanus</h1>
2+
<pre align="center">
3+
简约、高雅的 Valaxy 文档主题
4+
</pre>
1025

1036
<p align="center">
104-
<a href="https://sponsors.yunyoujun.cn">
105-
<img src='https://fastly.jsdelivr.net/gh/YunYouJun/sponsors/public/sponsors.svg'/>
106-
</a>
7+
<a href="https://www.npmjs.com/package/valaxy-theme-oceanus" rel="nofollow"><img src="https://img.shields.io/npm/v/valaxy-theme-oceanus/latest.svg?style=flat&colorA=18181B&colorB=0078E7" alt="NPM version"></a>
8+
<a href="https://www.npmjs.com/package/valaxy-theme-oceanus"><img src="https://img.shields.io/npm/dm/valaxy-theme-oceanus.svg?style=flat&colorA=18181B&colorB=0078E7" alt="Downloads"></a>
9+
<a href="https://github.com/wrxinyue/valaxy-theme-oceanus/tree/main/LICENSE"><img src="https://img.shields.io/github/license/wrxinyue/valaxy-theme-oceanus.svg?style=flat&colorA=18181B&colorB=0078E7" alt="License"></a>
10+
<a href="https://stackblitz.com/edit/stackblitz-starters-tqdtk7?file=README.md"><img src="https://img.shields.io/badge/Open in StackBlitz-_?logo=stackblitz&colorA=18181B&colorB=439CFF" alt="Open in StackBlitz"></a>
10711
</p>
108-
109-
https://github.com/primefaces/primevue/issues/6230
110-
111-
<ul>
112-
<li>
113-
<span title="首页" i-tabler-home inline-block />
114-
</li>
115-
<li>
116-
<span title="通知" i-tabler-bell inline-block />
117-
</li>
118-
<li>
119-
<span title="收藏" i-tabler-bookmarks inline-block />
120-
</li>
121-
<li>
122-
<span title="文章" i-tabler-file-description inline-block />
123-
</li>
124-
125-
<hr>
126-
<li>
127-
<span title="创建新文章" i-tabler-pencil-plus inline-block />
128-
</li>
129-
</ul>
130-
131-
首页toc默认为关闭

docs/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
"serve": "vite preview"
1010
},
1111
"dependencies": {
12-
"valaxy": "^0.22.5",
12+
"@iconify-json/carbon": "^1.2.8",
13+
"valaxy": "^0.22.16",
1314
"valaxy-theme-oceanus": "workspace:*"
1415
},
1516
"devDependencies": {

docs/pages/index.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,65 @@
22
title: 主页
33

44
features:
5+
subtitle: 特性
6+
title: 强大的功能
7+
text: Oceanus 主题提供了丰富的功能,满足各种文档和博客需求
8+
59
cards:
610
- title: 简单
711
details: 无需复杂配置,开箱即用,适合快速构建文档网站
12+
icon: i-carbon-chart-area-smooth
13+
num: "01"
814
- title: 关联式导航
915
details: 每个一级导航可绑定对应的二级导航,一级导航和二级导航支持绑定相应的侧边栏,形成清晰的导航结构
16+
icon: i-carbon-menu
17+
num: "02"
1018
- title: 版本控制与历史记录
1119
details: 集成 `valaxy-addon-git-log`,支持显示贡献者信息,查看不同版本的更改记录以及历史内容,便于追踪内容演变
20+
icon: i-carbon-version
21+
num: "03"
1222
- title: 简洁和现代
1323
details: 页面设计极其简约,强调内容和信息的可读性,去除多余装饰,采用大量留白以突出主要内容
24+
icon: i-carbon-clean
25+
num: "04"
1426
- title: 灵活
1527
details: 用户可以根据需求定制组件,并进行自由配置,满足个性化使用场景
28+
icon: i-carbon-settings
29+
num: "05"
1630
- title: 微动画
1731
details: 使用 subtle 的悬停动画和交互反馈,动画过渡流畅而不分散注意力
32+
icon: i-carbon-movement
33+
num: "06"
34+
35+
featuredArticles:
36+
subtitle: 精选文章
37+
title: 探索我们的热门内容
38+
description: 这些精选文章展示了 Oceanus 主题的强大功能和灵活性,帮助您快速了解如何充分利用这个主题。
39+
40+
articles:
41+
- title: 快速开始
42+
tags: ["指南", "入门"]
43+
path: /guide/getting-started/installation
44+
excerpt: 了解如何快速设置和配置 Oceanus 主题,开始构建您的文档或博客网站。
45+
- title: Markdown 写作
46+
tags: ["写作", "语法"]
47+
path: /guide/writing/markdown
48+
excerpt: 掌握 Markdown 语法和扩展功能,轻松创建格式丰富的内容,提升文档的可读性和美观度。
49+
- title: 导航配置
50+
tags: ["配置", "导航"]
51+
path: /reference/theme-config/nav
52+
excerpt: 学习如何配置网站的导航结构,创建清晰的信息层次,帮助用户轻松浏览您的内容。
1853

1954
contributors:
2055
subtitle: 贡献者
56+
title: 感谢所有贡献者
2157
text: 已获得 MIT 许可,并且将始终免费且开源。感谢 GitHub上的所有贡献者!
2258

2359
getStarted:
24-
title: Start building with Vite
25-
text: Prepare for a development environment that can finally keep pace with the speed of your mind.
60+
title: 开始使用 Oceanus 主题
61+
text: 准备好体验一个能够跟上您思维速度的开发环境,打造美观、高效的文档和博客网站。
2662
actions:
27-
- text: Become a Client
63+
- text: 开始使用
2864
link: /guide/getting-started/installation
2965
cards:
3066
- img: https://vite.dev/logo.svg

0 commit comments

Comments
 (0)