https://github.com/valaxyjs/valaxy-theme-starter
🎨 Starter template for valaxy-theme.
https://github.com/valaxyjs/valaxy-theme-starter
blog starter theme valaxy
Last synced: 3 months ago
JSON representation
🎨 Starter template for valaxy-theme.
- Host: GitHub
- URL: https://github.com/valaxyjs/valaxy-theme-starter
- Owner: valaxyjs
- License: mit
- Created: 2022-07-07T02:37:56.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-18T19:00:33.000Z (over 1 year ago)
- Last Synced: 2025-02-18T19:41:34.142Z (over 1 year ago)
- Topics: blog, starter, theme, valaxy
- Language: Vue
- Homepage: https://starter.valaxy.site
- Size: 1.75 MB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Valaxy-Theme-Starter(vue)
[](https://www.npmjs.com/package/valaxy-theme-starter)
[](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-` (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`
### 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)
