Go to file

YunYouJun 0ebb1b0abe ci: use lts node for workflows		2024-02-20 22:37:07 +08:00
.github	ci: use lts node for workflows	2024-02-20 22:37:07 +08:00
.husky	chore: use husky instead of simple-git-hooks	2022-07-19 20:05:23 +08:00
.vscode	feat(devtools): add update frontmatter api	2024-02-14 23:45:44 +08:00
cypress	test: add toc generate, close #12	2024-02-14 21:27:53 +08:00
demo	ci: use lts node for workflows	2024-02-20 22:37:07 +08:00
docs	ci: use lts node for workflows	2024-02-20 22:37:07 +08:00
packages	ci: use lts node for workflows	2024-02-20 22:37:07 +08:00
scripts	release: v0.18.0-beta.2	2024-02-14 19:16:54 +08:00
test	refactor: migrate to unplugin-vue-markdown	2024-02-10 21:31:21 +08:00
.eslintignore	chore: upgrade deps & lint	2023-10-03 00:15:39 +08:00
.gitignore	test(cypress): add cypress to test	2023-02-20 04:41:36 +08:00
.npmrc	chore: fix typecheck & seperate works	2022-06-07 03:50:13 +08:00
.stylelintrc.json	chore: stylelint scss	2023-10-07 09:47:17 +08:00
LICENSE	init: basic readme & occupy npm package name	2022-03-09 02:26:27 +08:00
README.md	docs: fix broken link in README (#332 )	2024-01-28 19:35:35 +08:00
README.zh-CN.md	docs: fix broken link in README (#332 )	2024-01-28 19:35:35 +08:00
api-extractor.json	docs: add theme comment & docs, close #166	2023-02-09 03:17:59 +08:00
cypress.config.ts	ci: add create-valaxy -y -p to test, close #205	2024-02-04 03:19:59 +08:00
eslint.config.js	chore: lint & upgrade fuse to esm	2023-12-12 22:43:29 +08:00
netlify.toml	ci: use lts node for workflows	2024-02-20 22:37:07 +08:00
package.json	ci: use lts node for workflows	2024-02-20 22:37:07 +08:00
pnpm-lock.yaml	ci: use lts node for workflows	2024-02-20 22:37:07 +08:00
pnpm-workspace.yaml	release: v0.17.3	2024-01-27 19:43:46 +08:00
tsconfig.json	feat(devtools): add update frontmatter api	2024-02-14 23:45:44 +08:00
uno.config.ts	feat(devtools): add postList & open in editor	2024-02-13 03:30:32 +08:00
vercel.json	chore: upgrade deps & add vercel.json redirects	2023-10-30 23:36:02 +08:00
vitest.config.ts	test: add check for ssg dist draft	2024-01-21 00:28:48 +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 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 unplugin-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:

README.md Unescape Escape