<h1 align="center"> <a href="https://valaxy.site">Valaxy</a> </h1> <p align="center"> 🌌 Next Generation Static Blog Framework (Beta). </p> <pre align="center"> 🧪 Working in Progress </pre> <p align="center"> <a href="https://www.npmjs.com/package/valaxy" rel="nofollow"><img src="https://img.shields.io/npm/v/valaxy?color=0078E7" alt="NPM version"></a> <a href="https://github.com/YunYouJun/valaxy/actions/workflows/release.yml"><img src="https://github.com/YunYouJun/valaxy/actions/workflows/release.yml/badge.svg" alt="Release"></a> <a href="https://discord.gg/nd3mPkU5j8" target="_blank"><img alt="Discord" src="https://img.shields.io/discord/752821465891733574?color=%234960ea&logo=discord"></a> <a href="https://gitcode.com/YunYouJun/valaxy" target="_blank"><img src="https://gitcode.com/YunYouJun/valaxy/star/badge.svg" alt="GitCode"/></a> </p>

English | 简体中文
English Docs | 中文文档 | Docs for Beta
Demo: <small>with valaxy-theme-yun</small>

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 an example, you can see demo/yun folder.

Features

⚡️ Vue 3, Vite 5, 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 vue-router
📦 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
☁️ 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:

Contributing

Thanks to everyone who has contributed to Valaxy

Valaxy

Install / Use

README