Skip to content
This repository has been archived by the owner on Feb 11, 2024. It is now read-only.

Commit

Permalink
feat: 初始化和部分迁移
Browse files Browse the repository at this point in the history
  • Loading branch information
zkz098 committed Nov 11, 2023
1 parent 269e58a commit 57c4895
Show file tree
Hide file tree
Showing 20 changed files with 654 additions and 1,387 deletions.
2 changes: 0 additions & 2 deletions .github/FUNDING.yml

This file was deleted.

37 changes: 0 additions & 37 deletions .github/workflows/gh-pages.yml

This file was deleted.

111 changes: 6 additions & 105 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,108 +1,9 @@
<p align="center">
Valaxy-Theme-Starter<sup><em>(vue)</em></sup>
</p>
# valaxy-theme-ShokaX
<pre align="center">
🧪 Working in Progress
</pre>
Hexo-theme-ShokaX 的 valaxy 迁移版

[![npm](https://img.shields.io/npm/v/valaxy-theme-starter)](https://www.npmjs.com/package/valaxy-theme-starter)
[![npm dev dependency version](https://img.shields.io/npm/dependency-version/valaxy-theme-starter/dev/valaxy)](https://github.com/YunYouJun/valaxy)
目前本项目尚未可用,迁移工作刚刚开始

> This is a template for creating a [valaxy](https://github.com/YunYouJun/valaxy) theme.

## Usage

### Clone to local

> Use [pnpm](https://pnpm.io/), because we need its workspace.
```bash
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
```

### Development

```bash
# dev node
pnpm dev
# dev client
pnpm demo
```

### Build

```bash
pnpm build
```

### Release

> Publish to [npm](https://www.npmjs.com/).
#### Manual

```bash
pnpm ci:publish
```

#### Auto by GitHub Actions

> 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 npm `Access Tokens` - `Automation`)

```bash
npm run release
# choose your version to automatic release
```

## Checklist

- [ ] Change the author name in `LICENSE` & `package.json` & `.github`
- [ ] Write `ThemeConfig` & Other init content
- [ ] Rename `valaxy-theme-starter` to `valaxy-theme-<name>` (custom it)
- [ ] Change `theme: 'starter'` to `theme: <name>` in `valaxy.config.ts`
- [ ] Each of your Vue components should have a namespace
- For example: `YunTest.vue` for `valaxy-theme-yun`


### About Checklist Rename

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

```bash
valaxy-theme-name
- package.json
- demo
- package.json
- valaxy.config.ts
- theme
- package.json
```

Let's write the theme & docs!

## Thanks

Starter theme ref theme:

- [vuejs/blog](https://github.com/vuejs/blog)
- [tailwind-nextjs-starter-blog](https://github.com/timlrx/tailwind-nextjs-starter-blog)

### [Sponsors](https://sponsors.yunyoujun.cn)

<p align="center">
<a href="https://sponsors.yunyoujun.cn">
<img src='https://fastly.jsdelivr.net/gh/YunYouJun/sponsors/public/sponsors.svg'/>
</a>
</p>
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"bumpp": "^9.2.0",
"eslint": "^8.52.0",
"typescript": "^5.2.2",
"valaxy": "^0.15.10",
"valaxy": "^0.15.13",
"valaxy-theme-starter": "workspace:*",
"vue-tsc": "^1.8.22"
}
Expand Down
Loading

0 comments on commit 57c4895

Please sign in to comment.