Go to file

YunYouJun f6297d77b4 docs: add brandIcons & fix code highlight lines		2023-10-04 06:01:19 +08:00
.github	ci: fix cypress	2023-10-04 04:35:33 +08:00
.husky	chore: use husky instead of simple-git-hooks	2022-07-19 20:05:23 +08:00
.vscode	chore: upgrade deps & lint	2023-10-03 00:15:39 +08:00
cypress	chore: upgrade deps & lint	2023-10-03 00:15:39 +08:00
demo	feat(styles): custom-block & new vars	2023-10-04 04:01:10 +08:00
docs	docs: add brandIcons & fix code highlight lines	2023-10-04 06:01:19 +08:00
packages	docs: add brandIcons & fix code highlight lines	2023-10-04 06:01:19 +08:00
scripts	docs: fix dead links	2023-10-04 05:38:48 +08:00
test	ci: fix cypress	2023-10-04 04:35:33 +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
LICENSE	init: basic readme & occupy npm package name	2022-03-09 02:26:27 +08:00
README.md	fix: site link & algolia search appKey	2023-03-29 11:05:04 +08:00
README.zh-CN.md	fix: site link & algolia search appKey	2023-03-29 11:05:04 +08:00
api-extractor.json	docs: add theme comment & docs, close #166	2023-02-09 03:17:59 +08:00
cypress.config.ts	test(cypress): add cypress to test	2023-02-20 04:41:36 +08:00
eslint.config.js	chore: upgrade deps & lint	2023-10-03 00:15:39 +08:00
netlify.toml	refactor: prune useless dependencies && not pull temp posts	2022-05-14 00:43:29 +08:00
package.json	feat(create-valaxy): add blog/theme/addon template	2023-10-04 02:59:05 +08:00
pnpm-lock.yaml	docs: add brandIcons & fix code highlight lines	2023-10-04 06:01:19 +08:00
pnpm-workspace.yaml	docs: add unocss & vue-components register	2023-07-17 21:47:11 +08:00
tsconfig.json	chore: upgrade deps & lint	2023-10-03 00:15:39 +08:00
uno.config.ts	docs: add addon gallery	2023-09-10 02:38:12 +08:00
vitest.config.ts	chore: fix lint & types cypress conflict with vitest	2023-02-20 04:46:52 +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