create-valaxy 0.0.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 云游君 YunYouJun <me@yunyoujun.cn>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,27 @@
+# create-valaxy
+
+[![NPM version](https://img.shields.io/npm/v/create-valaxy?color=0078E7)](https://www.npmjs.com/package/create-valaxy)
+
+Starter template generator for [valaxy](https://github.com/YunYouJun/valaxy).
+
+## Usage
+
+```bash
+npm init valaxy 
+```
+
+or
+
+```bash
+yarn create valaxy
+```
+
+or
+
+```bash
+pnpm create valaxy
+```
+
+## FAQ
+
+Use `chalk@4` `execa@5` for cjs.

package/index.js

@@ -0,0 +1,200 @@
+#!/usr/bin/env node
+/* eslint-disable no-console */
+/* eslint-disable @typescript-eslint/no-var-requires */
+
+// @ts-check
+const fs = require('fs')
+const path = require('path')
+const argv = require('minimist')(process.argv.slice(2))
+const prompts = require('prompts')
+const execa = require('execa')
+const chalk = require('chalk')
+const { version } = require('./package.json')
+
+const cwd = process.cwd()
+
+const renameFiles = {
+  _gitignore: '.gitignore',
+  _npmrc: '.npmrc',
+}
+
+async function init() {
+  console.log()
+  console.log(`  ${chalk.bold('🌌 Valaxy')}  ${chalk.blue(`v${version}`)}`)
+  console.log()
+
+  let targetDir = argv._[0]
+  if (!targetDir) {
+    /**
+     * @type {{ projectName: string }}
+     */
+    const { projectName } = await prompts({
+      type: 'text',
+      name: 'projectName',
+      message: 'Project name:',
+      initial: 'valaxy-blog',
+    })
+    targetDir = projectName.trim()
+
+    const packageName = await getValidPackageName(targetDir)
+    const root = path.join(cwd, targetDir)
+
+    if (fs.existsSync(root)) { fs.mkdirSync(root, { recursive: true }) }
+    else {
+      const existing = fs.readdirSync(root)
+      if (existing.length) {
+        console.log(chalk.yellow(`  Target directory "${targetDir}" is not empty.`))
+        /**
+       * @type {{ yes: boolean }}
+       */
+        const { yes } = await prompts({
+          type: 'confirm',
+          name: 'yes',
+          initial: 'Y',
+          message: 'Remove existing files and continue?',
+        })
+        if (yes)
+          emptyDir(root)
+
+        else
+          return
+      }
+    }
+
+    console.log(chalk.dim('  Scaffolding project in ') + targetDir + chalk.dim(' ...'))
+
+    const templateDir = path.join(__dirname, 'template')
+    const write = (file, content) => {
+      const targetPath = renameFiles[file]
+        ? path.join(root, renameFiles[file])
+        : path.join(root, file)
+      if (content)
+        fs.writeFileSync(targetPath, content)
+
+      else
+        copy(path.join(templateDir, file), targetPath)
+    }
+
+    const files = fs.readdirSync(templateDir)
+    for (const file of files.filter(f => f !== 'package.json'))
+      write(file)
+
+    // write pkg name & version
+    const pkg = require(path.join(templateDir, 'package.json'))
+    pkg.name = packageName
+    pkg.version = version
+
+    write('package.json', JSON.stringify(pkg, null, 2))
+
+    const pkgManager = (/pnpm/.test(process.env.npm_execpath) || /pnpm/.test(process.env.npm_config_user_agent))
+      ? 'pnpm'
+      : /yarn/.test(process.env.npm_execpath) ? 'yarn' : 'npm'
+
+    const related = path.relative(cwd, root)
+    console.log(chalk.green('  Done.\n'))
+
+    /**
+     * @type {{ yes: boolean }}
+     */
+    const { yes } = await prompts({
+      type: 'confirm',
+      name: 'yes',
+      initial: 'Y',
+      message: 'Install and start it now?',
+    })
+
+    if (yes) {
+      const { agent } = await prompts({
+        name: 'agent',
+        type: 'select',
+        message: 'Choose the agent',
+        choices: ['npm', 'yarn', 'pnpm'].map(i => ({ value: i, title: i })),
+      })
+
+      if (!agent)
+        return
+
+      await execa(agent, ['install'], { stdio: 'inherit', cwd: root })
+      await execa(agent, ['run', 'dev'], { stdio: 'inherit', cwd: root })
+    }
+    else {
+      console.log(chalk.dim('\n  start it later by:\n'))
+      if (root !== cwd)
+        console.log(chalk.blue(`  cd ${chalk.bold(related)}`))
+
+      console.log(chalk.blue(`  ${pkgManager === 'yarn' ? 'yarn' : `${pkgManager} install`}`))
+      console.log(chalk.blue(`  ${pkgManager === 'yarn' ? 'yarn dev' : `${pkgManager} run dev`}`))
+      console.log()
+      console.log(`  ${chalk.cyan('✨')}`)
+      console.log()
+    }
+  }
+}
+
+function copy(src, dest) {
+  const stat = fs.statSync(src)
+  if (stat.isDirectory())
+    copyDir(src, dest)
+
+  else
+    fs.copyFileSync(src, dest)
+}
+
+function copyDir(srcDir, destDir) {
+  fs.mkdirSync(destDir, { recursive: true })
+  for (const file of fs.readdirSync(srcDir)) {
+    const srcFile = path.resolve(srcDir, file)
+    const destFile = path.resolve(destDir, file)
+    copy(srcFile, destFile)
+  }
+}
+
+async function getValidPackageName(projectName) {
+  projectName = path.basename(projectName)
+  const packageNameRegExp = /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/
+  if (packageNameRegExp.test(projectName)) {
+    return projectName
+  }
+  else {
+    const suggestedPackageName = projectName
+      .trim()
+      .toLowerCase()
+      .replace(/\s+/g, '-')
+      .replace(/^[._]/, '')
+      .replace(/[^a-z0-9-~]+/g, '-')
+
+    /**
+     * @type {{ inputPackageName: string }}
+     */
+    const { inputPackageName } = await prompts({
+      type: 'text',
+      name: 'inputPackageName',
+      message: 'Package name:',
+      initial: suggestedPackageName,
+      validate: input =>
+        packageNameRegExp.test(input) ? true : 'Invalid package.json name',
+    })
+    return inputPackageName
+  }
+}
+
+function emptyDir(dir) {
+  if (!fs.existsSync(dir))
+    return
+
+  for (const file of fs.readdirSync(dir)) {
+    const abs = path.resolve(dir, file)
+    // baseline is Node 12 so can't use rmSync :(
+    if (fs.lstatSync(abs).isDirectory()) {
+      emptyDir(abs)
+      fs.rmdirSync(abs)
+    }
+    else {
+      fs.unlinkSync(abs)
+    }
+  }
+}
+
+init().catch((e) => {
+  console.error(e)
+})

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "create-valaxy",
+  "version": "0.0.5",
+  "main": "index.js",
+  "description": "Create Starter Template for Valaxy",
+  "homepage": "https://valaxy.yyj.moe",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/YunYouJun/valaxy"
+  },
+  "author": {
+    "email": "me@yunyoujun.cn",
+    "name": "YunYouJun",
+    "url": "https://www.yunyoujun.cn"
+  },
+  "funding": "https://github.com/sponsors/YunYouJun",
+  "bin": {
+    "create-valaxy": "index.js"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "dependencies": {
+    "chalk": "4",
+    "execa": "5",
+    "minimist": "^1.2.6",
+    "prompts": "^2.4.2"
+  },
+  "readme": "# create-valaxy\n\n[![NPM version](https://img.shields.io/npm/v/create-valaxy?color=0078E7)](https://www.npmjs.com/package/create-valaxy)\n\nStarter template generator for [valaxy](https://github.com/YunYouJun/valaxy).\n\n## Usage\n\n```bash\nnpm init valaxy \n```\n\nor\n\n```bash\nyarn create valaxy\n```\n\nor\n\n```bash\npnpm create valaxy\n```\n\n## FAQ\n\nUse `chalk@4` `execa@5` for cjs.\n"
+}

package/template/.github/workflows/gh-pages.yml

@@ -0,0 +1,38 @@
+name: GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+        os: [ubuntu-latest]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: https://registry.npmjs.org/
+
+      - name: 📦 Install Dependencies
+        run: npm i
+        
+      - name: 🌌 Build Valaxy Blog
+        run: npm run build
+
+      - name: 🪤 Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./dist
+          force_orphan: true

package/template/.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+  "recommendations": [
+    "antfu.iconify",
+    "antfu.unocss",
+    "csstools.postcss",
+    "dbaeumer.vscode-eslint",
+    "johnsoncodehk.volar",
+    "lokalise.i18n-ally"
+  ]
+}

package/template/.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+  "cSpell.words": ["valaxy", "valaxyjs"],
+  "i18n-ally.sourceLanguage": "en",
+  "i18n-ally.keystyle": "nested",
+  "i18n-ally.localesPaths": "locales",
+  "i18n-ally.sortKeys": true,
+  "prettier.enable": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "files.associations": {
+    "*.css": "postcss"
+  },
+  "editor.formatOnSave": false,
+  "svg.preview.background": "editor"
+}

package/template/README.md

@@ -0,0 +1,45 @@
+# create-valaxy
+
+Example: [valaxy.yyj.moe](https://valaxy.yyj.moe)
+
+## Usage
+
+```bash
+# 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.
+
+## 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](https://www.netlify.com/)
+- `vercel.json`: for [vercel](https://vercel.com/)

package/template/_gitignore

@@ -0,0 +1,13 @@
+# vite-ssg
+.vite-ssg-dist
+.vite-ssg-temp
+
+temp/
+
+.DS_Store
+*.local
+dist
+dist-ssr
+node_modules
+.idea/
+*.log

package/template/_npmrc

@@ -0,0 +1,2 @@
+# for pnpm
+shamefully-hoist=true

package/template/components/README.md

@@ -0,0 +1,7 @@
+# Components
+
+Components in this dir will be auto-registered and on-demand, powered by [`unplugin-vue-components`](https://github.com/antfu/unplugin-vue-components).
+
+## Icons
+
+You can use icons from almost any icon sets by the power of [Iconify](https://iconify.design/).

package/template/layouts/README.md

@@ -0,0 +1,3 @@
+# layouts
+
+You can override valaxy/theme layouts here.

package/template/locales/README.md

@@ -0,0 +1,3 @@
+# locales
+
+You can custom i18n here.

package/template/netlify.toml

@@ -0,0 +1,16 @@
+[build.environment]
+  NODE_VERSION = "16"
+
+[build]
+  publish = "dist"
+  command = "npm run build"
+
+[[redirects]]
+  from = "/*"
+  to = "/index.html"
+  status = 200
+
+[[headers]]
+  for = "/manifest.webmanifest"
+  [headers.values]
+    Content-Type = "application/manifest+json"

package/template/package.json

@@ -0,0 +1,12 @@
+{
+  "private": true,
+  "scripts": {
+    "build": "valaxy build",
+    "dev": "valaxy",
+    "serve": "vite preview"
+  },
+  "dependencies": {
+    "valaxy": "0.0.5",
+    "valaxy-theme-yun": "0.0.5"
+  }
+}

package/template/pages/about/index.md

@@ -0,0 +1,13 @@
+---
+title: 关于我
+---
+
+I am developing [Valaxy](https://github.com/YunYouJun/valaxy) - Next Generation Static Blog Framework.
+
+If you like it, you can sponsor me in [GitHub](https://github.com/sponsors/YunYouJun) or [sponsors.yunyoujun.cn](https://sponsors.yunyoujun.cn).
+
+---
+
+我正在开发 [Valaxy](https://github.com/YunYouJun/valaxy) - 下一代静态博客框架。
+
+如果你喜欢它，你可以在 [GitHub](https://github.com/sponsors/YunYouJun) 或 [sponsors.yunyoujun.cn](https://sponsors.yunyoujun.cn) 赞助我。

package/template/pages/about/site.md

@@ -0,0 +1,7 @@
+---
+title: 关于站点
+---
+
+Valaxy + valaxy-theme-yun Demo Site
+
+- Default Theme: [valaxy-theme-yun](https://github.com/YunYouJun/valaxy/blob/main/packages/valaxy-theme-yun/)

package/template/pages/archives/index.md

@@ -0,0 +1,5 @@
+---
+layout: archives
+nav: false
+comment: false
+---

package/template/pages/categories/index.md

@@ -0,0 +1,9 @@
+---
+layout: categories
+nav: false
+toc: false
+icon: i-ri-folder-2-line
+# You can custom title
+# title: 云游的小分类
+# comment: false
+---

package/template/pages/links/index.md

@@ -0,0 +1,9 @@
+---
+title: 我的小伙伴们
+keywords: 链接
+description: 云游的小伙伴们
+links: https://www.yunyoujun.cn/friends/links.json
+random: true
+---
+
+<YunLinks :links="frontmatter.links" :random="frontmatter.random" />

package/template/pages/posts/hello-valaxy.md

@@ -0,0 +1,20 @@
+---
+title: Hello, Valaxy!
+date: 2022-04-01
+updated: 2022-04-01
+categories: Valaxy 笔记
+tags:
+  - valaxy
+  - 笔记
+top: 1
+---
+
+## Valaxy
+
+Next Generation Static Blog Framework.
+
+Write your first post!
+
+## Usage
+
+Modify `valaxy.config.ts` to custom your blog.

package/template/pages/tags/index.md

@@ -0,0 +1,7 @@
+---
+layout: tags
+# title: 云游的小标签
+icon: i-ri-price-tag-3-line
+nav: false
+# comment: false
+---

package/template/styles/README.md

@@ -0,0 +1,8 @@
+# styles
+
+You can override styles here.
+
+- New file `index.scss` to write global css.
+- New file `vars.scss` to set css vars.
+
+Only `index.scss`/`vars.scss`/`index.css` will be loaded automatically.

package/template/styles/index.scss

@@ -0,0 +1 @@
+// you can custom css here

package/template/styles/vars.scss

@@ -0,0 +1 @@
+// you can custom css vars here

package/template/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["demo/yun/*"],
+    }
+  },
+  "exclude": ["dist", "node_modules"]
+}

package/template/valaxy.config.ts

@@ -0,0 +1,152 @@
+import type { UserConfig } from 'valaxy'
+import type { ThemeUserConfig } from 'valaxy-theme-yun'
+
+/**
+ * User Config
+ * do not use export const
+ */
+const config: UserConfig<ThemeUserConfig> = {
+  lang: 'zh-CN',
+  title: 'Valaxy Theme Yun',
+  author: {
+    name: '云游君',
+  },
+  description: 'Valaxy Theme Yun Preview.',
+  social: [
+    {
+      name: 'RSS',
+      link: '/atom.xml',
+      icon: 'i-ri-rss-line',
+      color: 'orange',
+    },
+    {
+      name: 'QQ 群 1050458482',
+      link: 'https://qm.qq.com/cgi-bin/qm/qr?k=kZJzggTTCf4SpvEQ8lXWoi5ZjhAx0ILZ&jump_from=webapi',
+      icon: 'i-ri-qq-line',
+      color: '#12B7F5',
+    },
+    {
+      name: 'GitHub',
+      link: 'https://github.com/YunYouJun',
+      icon: 'i-ri-github-line',
+      color: '#6e5494',
+    },
+    {
+      name: '微博',
+      link: 'https://weibo.com/jizhideyunyoujun',
+      icon: 'i-ri-weibo-line',
+      color: '#E6162D',
+    },
+    {
+      name: '豆瓣',
+      link: 'https://www.douban.com/people/yunyoujun/',
+      icon: 'i-ri-douban-line',
+      color: '#007722',
+    },
+    {
+      name: '网易云音乐',
+      link: 'https://music.163.com/#/user/home?id=247102977',
+      icon: 'i-ri-netease-cloud-music-line',
+      color: '#C20C0C',
+    },
+    {
+      name: '知乎',
+      link: 'https://www.zhihu.com/people/yunyoujun/',
+      icon: 'i-ri-zhihu-line',
+      color: '#0084FF',
+    },
+    {
+      name: '哔哩哔哩',
+      link: 'https://space.bilibili.com/1579790',
+      icon: 'i-ri-bilibili-line',
+      color: '#FF8EB3',
+    },
+    {
+      name: '微信公众号',
+      link: 'https://cdn.jsdelivr.net/gh/YunYouJun/cdn/img/about/white-qrcode-and-search.jpg',
+      icon: 'i-ri-wechat-2-line',
+      color: '#1AAD19',
+    },
+    {
+      name: 'Twitter',
+      link: 'https://twitter.com/YunYouJun',
+      icon: 'i-ri-twitter-line',
+      color: '#1da1f2',
+    },
+    {
+      name: 'Telegram Channel',
+      link: 'https://t.me/elpsycn',
+      icon: 'i-ri-telegram-line',
+      color: '#0088CC',
+    },
+    {
+      name: 'E-Mail',
+      link: 'mailto:me@yunyoujun.cn',
+      icon: 'i-ri-mail-line',
+      color: '#8E71C1',
+    },
+    {
+      name: 'Travelling',
+      link: 'https://travellings.link',
+      icon: 'i-ri-train-line',
+      color: 'var(--yun-c-text)',
+    },
+  ],
+
+  search: {
+    algolia: {
+      enable: true,
+      appId: 'CJXXAGRCYN',
+      apiKey: 'ae1966d2aeab22bf9335679f45d2cd9a',
+      indexName: 'my-hexo-blog',
+    },
+  },
+
+  theme: 'yun',
+
+  themeConfig: {
+    banner: {
+      enable: true,
+      title: '云游君的小站',
+    },
+
+    pages: [
+      {
+        name: '我的小伙伴们',
+        url: '/links/',
+        icon: 'i-ri-genderless-line',
+        color: 'dodgerblue',
+      },
+      {
+        name: '喜欢的女孩子',
+        url: '/girls/',
+        icon: 'i-ri-women-line',
+        color: 'hotpink',
+      },
+    ],
+
+    footer: {
+      since: 2016,
+      beian: {
+        enable: true,
+        icp: '苏ICP备17038157号',
+      },
+    },
+  },
+
+  unocss: {
+    safelist: [
+      'i-ri-home-line',
+    ],
+  },
+}
+
+/**
+ * add your icon to safelist
+ * if your theme is not yun, so you can add it by yourself
+ */
+config.themeConfig?.pages?.forEach((item) => {
+  config.unocss?.safelist?.push(item?.icon)
+})
+
+export default config

package/template/vercel.json

@@ -0,0 +1,8 @@
+{
+  "rewrites": [
+    {
+      "source": "/(.*)",
+      "destination": "/index.html"
+    }
+  ]
+}