Go to file

YunYouJun a0c7010950 fix: docs build		2023-01-25 23:37:08 +08:00
.github	chore: fix typecheck	2023-01-25 02:22:39 +08:00
.husky	chore: use husky instead of simple-git-hooks	2022-07-19 20:05:23 +08:00
.vscode	fix(theme-yun): tag wrap in safari browser	2023-01-23 00:04:18 +08:00
demo	feat(addon-twikoo): new valaxy-addon and docs	2023-01-24 05:34:01 +08:00
docs	fix: docs build	2023-01-25 23:37:08 +08:00
packages	fix: docs build	2023-01-25 23:37:08 +08:00
scripts	release: v0.3.4	2022-05-14 04:03:55 +08:00
test	refactor: extract site common configs to siteConfig & support site.config.ts	2023-01-23 05:06:12 +08:00
.eslintignore	fix: not add config file to entries & export useLocale	2022-07-09 08:34:54 +08:00
.eslintrc	fix: add __DEV__ and remove client about/index.md	2022-04-05 23:39:25 +08:00
.gitignore	fix: typecheck & addon vitest & remove useless index.html	2022-11-25 02:07:31 +08:00
.npmrc	chore: fix typecheck & seperate works	2022-06-07 03:50:13 +08:00
LICENSE	init: basic readme & occupy npm package name	2022-03-09 02:26:27 +08:00
README.md	feat: can resolve themeConfig from theme.config.ts	2023-01-25 23:22:43 +08:00
README.zh-CN.md	feat: can resolve themeConfig from theme.config.ts	2023-01-25 23:22:43 +08:00
netlify.toml	refactor: prune useless dependencies && not pull temp posts	2022-05-14 00:43:29 +08:00
package.json	release: v0.13.4	2023-01-25 22:34:00 +08:00
pnpm-lock.yaml	fix(theme-yun): valaxy-addon-algolia external	2023-01-25 22:33:49 +08:00
pnpm-workspace.yaml	init: basic monorepo structure	2022-03-15 03:39:34 +08:00
tsconfig.json	chore: set vitest globals to true (#113 )	2022-08-21 17:09:30 +08:00
vitest.config.ts	chore: set vitest globals to true (#113 )	2022-08-21 17:09:30 +08:00

README.md

Valaxy

🌌 Next Generation Static Blog Framework (Beta).

🧪 Working in Progress

Usage

Try it Online

Init Project Locally

Just run the following command to init your blog:

# pnpm (recommended)
pnpm create valaxy
# npm
# npm init valaxy
# yarn
# yarn create valaxy

For a example, you can see demo/yun folder.

Features

⚡️ Vue 3, Vite 4, pnpm, ESBuild - born with fastness
🔥 Hot Reload with Config & Markdown
🔧 Type Tooltip for all config by valaxy.config.ts
🗒 Extended Markdown Frontmatter
🗂 File based routing via vite-plugin-pages
📦 Components auto importing via unplugin-vue-components
🖨 Static-site generation (SSG) via vite-ssg (SPA is OK!)
🕸 RSS & Sitemap
🎨 Free to use Tailwind CSS via UnoCSS
🌍 CSS i18n in One Page
🔍 Use icons from any icon sets with classes - Icônes
👔 Extended Theme with Layout system
⚙️ Unit Testing with Vitest (Todo)
☁️ Deploy zero-config
- Netlify with netlify.toml
- GitHub Pages with .github/workflows/gh-pages.yml GitHub Actions
♻️ Use any vite plugins
- 📲 You can implement PWA by vite-plugin-pwa
...

Dev

Want to get involved in the development? Look here.

Want to create your theme? Check valaxy-theme-starter.

Thanks

💗 The implementation of Valaxy is based on or refer the following projects:

README.md Unescape Escape