Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mlemoe/valaxy-theme-moe
a valaxy theme just for fun and a promise.
https://github.com/mlemoe/valaxy-theme-moe
Last synced: about 1 month ago
JSON representation
a valaxy theme just for fun and a promise.
- Host: GitHub
- URL: https://github.com/mlemoe/valaxy-theme-moe
- Owner: MleMoe
- License: mit
- Created: 2022-07-10T07:37:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-10T13:44:03.000Z (over 2 years ago)
- Last Synced: 2024-10-29T15:51:31.370Z (3 months ago)
- Language: Vue
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Valaxy-Theme-Moe(vue)
> This is a [valaxy](https://github.com/YunYouJun/valaxy) theme just for fun and a promise.
## Usage
### Clone to local
> Use [pnpm](https://pnpm.io/), because we need its workspace.
```bash
git clone [email protected]:MleMoe/valaxy-theme-moe.git
cd valaxy-theme-moe
# If you don't have pnpm installed, run: 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-` (custom it)
- [ ] Change `theme: 'starter'` to `theme: ` in `valaxy.config.ts`
- [ ] Each of your Vue components should have a namespace
- For example: `YunTest.vue` for `valaxy-theme-yun`
Let's write the theme & docs!
## Thanks
Thanks to xiao yun