Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/YunYouJun/valaxy

🌌 Next Generation Static Blog Framework (Beta) 下一代静态博客框架(支持页面/配置热重载)
https://github.com/YunYouJun/valaxy

blog site static valaxy yun

Last synced: about 2 months ago
JSON representation

🌌 Next Generation Static Blog Framework (Beta) 下一代静态博客框架(支持页面/配置热重载)

Awesome Lists containing this project

README

        


Valaxy


🌌 Next Generation Static Blog Framework (Beta).


🧪 Working in Progress


NPM version
Release

Discord

- **English** | [简体中文](./README.zh-CN.md)
- [English Docs](https://valaxy.site/?lang=en) | [中文文档](https://valaxy.site/?lang=zh-CN) | [Docs for Beta](https://beta.valaxy.site)
- [Demo](https://yun.valaxy.site): with [valaxy-theme-yun](./packages/valaxy-theme-yun/)

## Usage

### Try it Online

[![StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/edit/valaxy)

### Init Project Locally

Just run the following command to init your blog:

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

For a example, you can see [demo/yun](./demo/yun/) folder.

## Features

- ⚡️ [Vue 3](https://github.com/vuejs/vue-next), [Vite 5](https://github.com/vitejs/vite), [pnpm](https://pnpm.js.org/), [ESBuild](https://github.com/evanw/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 [unplugin-vue-router](https://github.com/posva/unplugin-vue-router)
- 📦 Components auto importing via [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components)
- 🖨 Static-site generation (SSG) via [vite-ssg](https://github.com/antfu/vite-ssg) (SPA is OK!)
- 🕸 RSS & Sitemap
- 🎨 Free to use Tailwind CSS via [UnoCSS](https://github.com/antfu/unocss)
- 🌍 [CSS i18n in One Page](https://valaxy.site/guide/i18n)
- 🔍 [Use icons from any icon sets with classes](https://github.com/antfu/unocss/tree/main/packages/preset-icons) - [Icônes](https://icones.netlify.app/)
- 👔 Extended Theme with [Layout system](https://github.com/JohnCampionJr/vite-plugin-vue-layouts)
- ⚙️ Unit Testing with [Vitest](https://github.com/vitest-dev/vitest)
- ☁️ Deploy zero-config
- [Netlify](https://www.netlify.com/) with `netlify.toml`
- [GitHub Pages](https://pages.github.com/) with `.github/workflows/gh-pages.yml` [GitHub Actions](https://github.com/features/actions)
- ♻️ Use any vite plugins
- 📲 You can implement PWA by [vite-plugin-pwa](https://github.com/antfu/vite-plugin-pwa)
- ...

## Dev

Want to get involved in the development? Look [here](https://valaxy.site/dev).

Want to create your theme? Check [valaxy-theme-starter](https://github.com/YunYouJun/valaxy-theme-starter).

## Thanks

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

- [Vue](https://github.com/vuejs/core)
- [VueUse](https://github.com/vueuse/vueuse)
- [Vite](https://github.com/vitejs/vite)
- [VitePress](https://github.com/vuejs/vitepress)
- [Vitesse](https://github.com/antfu/vitesse)
- [Slidev](https://github.com/slidevjs/slidev)

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

❤️ Special thanks to the following sponsors for their support.