|
1 | | -<p align="center"> |
2 | | -Valaxy-Theme-Oceanus<sup><em>(vue)</em></sup> |
3 | | -</p> |
4 | | - |
5 | | -[](https://www.npmjs.com/package/valaxy-theme-starter) |
6 | | -[](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> |
102 | 5 |
|
103 | 6 | <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> |
107 | 11 | </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默认为关闭 |
0 commit comments