Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 1.07 KB

README.md

File metadata and controls

51 lines (34 loc) · 1.07 KB
Raw

create-valaxy

Example: valaxy.site

Usage

# install
npm i
# or pnpm i

# start
npm run dev
# or pnpm dev

See http://localhost:4859/, have fun!

Config

Modify valaxy.config.ts to custom your blog.

English & Chinese Docs is coming!

Wait a minute.

Docker

docker build . -t your-valaxy-blog-name:latest

Structure

In most cases, you only need to work in the pages folder.

Main folders

  • pages: your all pages
    • posts: write your posts here, will be counted as posts
  • styles: override theme styles, index.scss/vars.csss/index.css will be loaded automatically
  • components: custom your vue components (will be loaded automatically)
  • layouts: custom layouts (use it by layout: xxx in md)
  • locales: custom i18n

Other

  • .vscode: recommend some useful plugins & settings, you can preview icon/i18n/class...
  • .github: GitHub Actions to auto build & deploy to GitHub Pages
  • netlify.toml: for netlify
  • vercel.json: for vercel