Valaxy-Theme-Oceanus(vue)
This is a template for creating a valaxy theme.
Use pnpm, because we need its workspace.
npx degit YunYouJun/valaxy-theme-starter valaxy-theme-name
cd valaxy-theme-name
# If you don't have pnpm installed
npm install -g pnpm
pnpm i
# dev node
pnpm dev
# dev client
pnpm demo
pnpm build
Publish to npm.
pnpm ci:publish
You can release it by github actions.
Click Settings
-> Secrets
-> Actions
in your GitHub repo.
Add New repository secret
:
NPM_TOKEN
:your npm token
(Generate from your npmAccess Tokens
-Automation
)
npm run release
# choose your version to automatic release
- Change the author name in
LICENSE
&package.json
&.github
- Write
ThemeConfig
& Other init content - Rename
valaxy-theme-starter
tovalaxy-theme-<name>
(custom it) - Change
theme: 'starter'
totheme: <name>
invalaxy.config.ts
- Each of your Vue components should have a namespace
- For example:
YunTest.vue
forvalaxy-theme-yun
- For example:
Rename valaxy-theme-starter
with valaxy-theme-name
in the package.json
and valaxy.config.ts
files.
PS: there are a total of four files that need to be rename
valaxy-theme-name
- package.json
- demo
- package.json
- valaxy.config.ts
- theme
- package.json
Let's write the theme & docs!
Starter theme ref theme:
<ul>
<li>
<span title="首页" i-tabler-home inline-block />
</li>
<li>
<span title="通知" i-tabler-bell inline-block />
</li>
<li>
<span title="收藏" i-tabler-bookmarks inline-block />
</li>
<li>
<span title="文章" i-tabler-file-description inline-block />
</li>
<hr>
<li>
<span title="创建新文章" i-tabler-pencil-plus inline-block />
</li>
</ul>
首页toc默认为关闭