valaxy 0.1.1 → 0.2.1

package/src/client/styles/vars.scss

@@ -18,22 +18,10 @@ $font: map.merge((
   'serif-weight': 900,
 ), $font);
 
-$z-index: () !default;
-$z-index: map.merge((
-  'cloud': 8,
-  'go-down': 9,
-  'sidebar': 10,
-  'fireworks': 11,
-  'menu-btn': 20,
-  'go-up-btn': 20,
-  'search-popup': 30,
-  'search-btn': 31,
-), $z-index);
-
 $transition: () !default;
 $transition: map.merge((
   'duration-fast': 0.2s,
   'duration': 0.4s,
   'duration-slow': 0.6s,
-  '': all var(--yun-transition-duration-fast) ease-in-out
+  '': all var(--va-transition-duration-fast) ease-in-out
 ), $transition);

package/src/client/styles/widgets/banner.scss

@@ -70,7 +70,7 @@ $char-animation-duration: 0.4s;
 
   &-left {
     border-left: 1px solid var(--banner-line-color);
-    border-right: 0px solid rgba(var(--yun-c-primary-rgb), 0.1);
+    border-right: 0px solid rgba(var(--va-c-primary-rgb), 0.1);
     border-right-width: 0px;
     animation-name: char-move-left;
     animation-duration: $char-animation-duration;
@@ -80,7 +80,7 @@ $char-animation-duration: 0.4s;
   }
 
   &-right {
-    border-left: 0px solid rgba(var(--yun-c-primary-rgb), 0.1);
+    border-left: 0px solid rgba(var(--va-c-primary-rgb), 0.1);
     border-right: 1px solid var(--banner-line-color);
     border-left-width: 0px;
     animation-name: char-move-right;

package/src/client/utils/index.ts

@@ -1,4 +1,2 @@
 export * from './helper'
 export * from './time'
-
-export const isDev = import.meta.env.DEV === true

package/src/node/build.ts

@@ -1,5 +1,8 @@
 import type { InlineConfig } from 'vite'
 import { mergeConfig, build as viteBuild } from 'vite'
+import { build as viteSsgBuild } from 'vite-ssg/node'
+import generateSitemap from 'vite-ssg-sitemap'
+
 import type { ResolvedValaxyOptions } from './options'
 import { createViteConfig } from './vite'
 
@@ -7,6 +10,22 @@ export async function build(
   options: ResolvedValaxyOptions,
   viteConfig: InlineConfig = {},
 ) {
-  const inlineConfig = mergeConfig(viteConfig, createViteConfig(options))
+  const inlineConfig = mergeConfig(await createViteConfig(options), viteConfig)
   await viteBuild(inlineConfig)
 }
+
+export async function ssgBuild(
+  options: ResolvedValaxyOptions,
+  viteConfig: InlineConfig = {},
+) {
+  const inlineConfig: InlineConfig = mergeConfig(await createViteConfig(options), viteConfig)
+
+  // https://github.com/antfu/vite-ssg
+  inlineConfig.ssgOptions = {
+    script: 'async',
+    formatting: 'minify',
+    onFinished() { generateSitemap() },
+  }
+
+  await viteSsgBuild({}, inlineConfig)
+}

package/src/node/cli.ts

@@ -6,15 +6,17 @@ import yargs from 'yargs'
 import type { InlineConfig, LogLevel } from 'vite'
 import openBrowser from 'open'
 
-// @ts-expect-error https://github.com/antfu/vite-ssg/pull/225
-import { build as ssgBuild } from 'vite-ssg/node'
-
 import consola from 'consola'
 
 import { version } from '../../package.json'
 import { resolveOptions } from './options'
 import { bindShortcut, initServer, printInfo } from './utils/cli'
 
+// build
+import { build, ssgBuild } from './build'
+// rss
+import { build as rssBuild } from './rss'
+
 const cli = yargs.scriptName('valaxy')
   .usage('$0 [args]')
   .version(version)
@@ -121,22 +123,29 @@ cli.command(
       describe: 'output dir',
     }).option('base', {
       type: 'string',
+      default: '/',
       describe: 'output base',
     })
     .strict()
     .help(),
   async({ ssg, root, base, output }) => {
-    const options = await resolveOptions({ userRoot: root })
+    const options = await resolveOptions({ userRoot: root }, 'build')
     printInfo(options)
 
+    const viteConfig = {
+      base,
+      build: {
+        // make out dir empty, https://vitejs.dev/config/#build-emptyoutdir
+        emptyOutDir: true,
+        outDir: path.resolve(options.userRoot, output),
+      },
+    }
+
     if (ssg) {
       consola.info('use vite-ssg to do ssg build...')
+
       try {
-        // wait vite-ssg can pass custom options
-        // https://github.com/antfu/vite-ssg/issues/226
-        await ssgBuild({
-          mode: 'production',
-        })
+        await ssgBuild(options, viteConfig)
       }
       catch (e) {
         consola.error('[vite-ssg] An internal error occurred.')
@@ -144,21 +153,25 @@ cli.command(
       }
     }
     else {
-      const { build } = await import('./build')
-
       consola.info('use vite do spa build...')
-      await build(options, {
-        base,
-        build: {
-          // make out dir empty, https://vitejs.dev/config/#build-emptyoutdir
-          emptyOutDir: true,
-          outDir: path.resolve(options.userRoot, output),
-        },
-      })
+      await build(options, viteConfig)
     }
   },
 )
 
+cli.command(
+  'rss [root]',
+  'generate rss feed',
+  args => commonOptions(args)
+    .strict()
+    .help(),
+  async({ root }) => {
+    consola.info('Generate RSS ...')
+    const options = await resolveOptions({ userRoot: root }, 'build')
+    await rssBuild(options)
+  },
+)
+
 /**
  * set common options for cli
  * @param args

package/src/node/markdown/headings.ts

@@ -4,10 +4,11 @@ import type { MarkdownRenderer } from '../markdown'
 import { deeplyParseHeader } from './parseHeader'
 import { slugify } from './slugify'
 
-export const headingPlugin = (md: MarkdownIt, include = ['h2', 'h3']) => {
+export const headingPlugin = (md: MarkdownIt, include = [1, 2, 3, 4]) => {
   md.renderer.rules.heading_open = (tokens, i, options, env, self) => {
     const token = tokens[i]
-    if (include.includes(token.tag)) {
+    const tags = include.map(item => `h${item}`)
+    if (tags.includes(token.tag)) {
       const title = tokens[i + 1].content
       const idAttr = token.attrs!.find(([name]) => name === 'id')
       const slug = idAttr && idAttr[1]

package/src/node/markdown/highlight.ts

@@ -0,0 +1,50 @@
+import consola from 'consola'
+import escapeHtml from 'escape-html'
+import prism from 'prismjs'
+
+// prism is listed as actual dep so it's ok to require
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const loadLanguages = require('prismjs/components/index')
+
+// required to make embedded highlighting work...
+loadLanguages(['markup', 'css', 'javascript'])
+
+function wrap(code: string, lang: string): string {
+  if (lang === 'text')
+    code = escapeHtml(code)
+
+  return `<pre v-pre><code>${code}</code></pre>`
+}
+
+export const highlight = (str: string, lang: string) => {
+  if (!lang)
+    return wrap(str, 'text')
+
+  lang = lang.toLowerCase()
+  const rawLang = lang
+  if (lang === 'vue' || lang === 'html')
+    lang = 'markup'
+
+  if (lang === 'md')
+    lang = 'markdown'
+
+  if (lang === 'ts')
+    lang = 'typescript'
+
+  if (lang === 'py')
+    lang = 'python'
+
+  if (!prism.languages[lang]) {
+    try {
+      loadLanguages([lang])
+    }
+    catch (e) {
+      consola.warn(`[valaxy] Syntax highlight for language "${lang}" is not supported.`)
+    }
+  }
+  if (prism.languages[lang]) {
+    const code = prism.highlight(str, prism.languages[lang], lang)
+    return wrap(code, rawLang)
+  }
+  return wrap(str, 'text')
+}

package/src/node/markdown/highlightLines.ts

@@ -0,0 +1,96 @@
+// Modified from https://github.com/egoist/markdown-it-highlight-lines
+import type MarkdownIt from 'markdown-it'
+
+const wrapperRE = /^<pre .*?><code>/
+
+export const highlightLinePlugin = (md: MarkdownIt) => {
+  const fence = md.renderer.rules.fence!
+  md.renderer.rules.fence = (...args) => {
+    const [tokens, idx, options] = args
+    const token = tokens[idx]
+
+    // due to use of markdown-it-attrs, the {0} syntax would have been converted
+    // to attrs on the token
+    const attr = token.attrs && token.attrs[0]
+    if (!attr)
+      return fence(...args)
+
+    const lines = attr[0]
+    if (!lines || !/[\d,-]+/.test(lines))
+      return fence(...args)
+
+    const lineNumbers = lines
+      .split(',')
+      .map(v => v.split('-').map(v => parseInt(v, 10)))
+
+    const code = options.highlight
+      ? options.highlight(token.content, token.info, '')
+      : token.content
+
+    const rawCode = code.replace(wrapperRE, '')
+    const highlightLinesCode = rawCode
+      .split('\n')
+      .map((split, index) => {
+        const lineNumber = index + 1
+        const inRange = lineNumbers.some(([start, end]) => {
+          if (start && end)
+            return lineNumber >= start && lineNumber <= end
+
+          return lineNumber === start
+        })
+        if (inRange)
+          return '<div class="highlighted">&nbsp;</div>'
+
+        return '<br>'
+      })
+      .join('')
+
+    const highlightLinesWrapperCode = `<div class="highlight-lines">${highlightLinesCode}</div>`
+
+    return highlightLinesWrapperCode + code
+  }
+}
+
+// markdown-it plugin for wrapping <pre> ... </pre>.
+//
+// If your plugin was chained before preWrapper, you can add additional element directly.
+// If your plugin was chained after preWrapper, you can use these slots:
+//   1. <!--beforebegin-->
+//   2. <!--afterbegin-->
+//   3. <!--beforeend-->
+//   4. <!--afterend-->
+export const preWrapperPlugin = (md: MarkdownIt) => {
+  const fence = md.renderer.rules.fence!
+  md.renderer.rules.fence = (...args) => {
+    const [tokens, idx] = args
+    const token = tokens[idx]
+    const rawCode = fence(...args)
+    return `<div class="language-${token.info.trim()}">${rawCode}</div>`
+  }
+}
+
+// markdown-it plugin for generating line numbers.
+// It depends on preWrapper plugin.
+export const lineNumberPlugin = (md: MarkdownIt) => {
+  const fence = md.renderer.rules.fence!
+  md.renderer.rules.fence = (...args) => {
+    const rawCode = fence(...args)
+    const code = rawCode.slice(
+      rawCode.indexOf('<code>'),
+      rawCode.indexOf('</code>'),
+    )
+
+    const lines = code.split('\n')
+    const lineNumbersCode = [...Array(lines.length - 1)]
+      .map((line, index) => `<span class="line-number">${index + 1}</span><br>`)
+      .join('')
+
+    const lineNumbersWrapperCode = `<div class="line-numbers-wrapper">${lineNumbersCode}</div>`
+
+    const finalCode = rawCode
+      .replace(/<\/div>$/, `${lineNumbersWrapperCode}</div>`)
+      .replace(/"(language-\w+)"/, '"$1 line-numbers-mode"')
+
+    return finalCode
+  }
+}

package/src/node/markdown/index.ts

@@ -2,9 +2,10 @@ import type MarkdownIt from 'markdown-it'
 
 import Anchor from 'markdown-it-anchor'
 import Emoji from 'markdown-it-emoji'
-import Prism from 'markdown-it-prism'
 import LinkAttributes from 'markdown-it-link-attributes'
 import TOC from 'markdown-it-table-of-contents'
+import TaskLists from 'markdown-it-task-lists'
+import attrs from 'markdown-it-attrs'
 
 import type { KatexOptions } from 'katex'
 import Katex from '../markdown/markdown-it-katex'
@@ -12,6 +13,8 @@ import { containerPlugin } from '../markdown/markdown-it-container'
 import { headingPlugin } from '../markdown/headings'
 import { slugify } from './slugify'
 import { parseHeader } from './parseHeader'
+import { highlight } from './highlight'
+import { highlightLinePlugin, preWrapperPlugin } from './highlightLines'
 
 export interface Header {
   level: number
@@ -39,18 +42,25 @@ export interface MarkdownOptions extends MarkdownIt.Options {
 }
 
 export function setupMarkdownPlugins(md: MarkdownIt, mdOptions: MarkdownOptions = {}) {
+  md.set({
+    highlight,
+  })
   md
+    .use(highlightLinePlugin)
+    .use(preWrapperPlugin)
     .use(containerPlugin)
-    .use(headingPlugin)
-  // https://prismjs.com/
-  md.use(Prism)
-  md.use(LinkAttributes, {
-    matcher: (link: string) => /^https?:\/\//.test(link),
-    attrs: {
-      target: '_blank',
-      rel: 'noopener',
-    },
-  })
+    .use(headingPlugin, mdOptions?.toc?.includeLevel)
+    // .use(lineNumberPlugin)
+  // https://github.com/arve0/markdown-it-attrs
+  // add classes
+  md.use(attrs)
+    .use(LinkAttributes, {
+      matcher: (link: string) => /^https?:\/\//.test(link),
+      attrs: {
+        target: '_blank',
+        rel: 'noopener',
+      },
+    })
   md.use(Katex, mdOptions.katex)
     .use(Anchor, {
       slugify,
@@ -58,11 +68,12 @@ export function setupMarkdownPlugins(md: MarkdownIt, mdOptions: MarkdownOptions
     })
     .use(TOC, {
       slugify,
-      includeLevel: [2, 3],
+      includeLevel: [2, 3, 4],
       format: parseHeader,
       ...mdOptions.toc,
     })
     .use(Emoji)
+    .use(TaskLists)
 
   const originalRender = md.render
   md.render = (...args) => {

package/src/node/markdown/markdown-it-container.ts

@@ -24,7 +24,7 @@ function createContainer(classes: string, defaultTitle: string): ContainerArgs {
         if (token.nesting === 1) {
           if (classes === 'details') {
             return `<details class="${classes} custom-block">${
-              info ? `<summary>${info}</summary>` : ''
+              `<summary>${info}</summary>`
             }\n`
           }
           return `<div class="${classes} custom-block"><p class="custom-block-title">${
@@ -50,4 +50,12 @@ export const containerPlugin = (md: MarkdownIt) => {
       render: (tokens: Token[], idx: number) =>
         tokens[idx].nesting === 1 ? '<div v-pre>\n' : '</div>\n',
     })
+
+  const languages = ['zh-CN', 'en']
+  languages.forEach((lang) => {
+    md.use(container, lang, {
+      render: (tokens: Token[], idx: number) =>
+        tokens[idx].nesting === 1 ? `<div lang="${lang}">\n` : '</div>\n',
+    })
+  })
 }

package/src/node/markdown/markdown-it-katex.ts

@@ -41,11 +41,13 @@ function isValidDelim(state: any, pos: number) {
 function math_inline(state: any, silent: boolean) {
   let match, token, res, pos
 
-  if (state.src[state.pos] !== '$') return false
+  if (state.src[state.pos] !== '$')
+    return false
 
   res = isValidDelim(state, state.pos)
   if (!res.can_open) {
-    if (!silent) state.pending += '$'
+    if (!silent)
+      state.pending += '$'
     state.pos += 1
     return true
   }
@@ -64,20 +66,23 @@ function math_inline(state: any, silent: boolean) {
     while (state.src[pos] === '\\') pos -= 1
 
     // Even number of escapes, potential closing delimiter found
-    if (((match - pos) % 2) === 1) break
+    if (((match - pos) % 2) === 1)
+      break
     match += 1
   }
 
   // No closing delimter found.  Consume $ and continue.
   if (match === -1) {
-    if (!silent) state.pending += '$'
+    if (!silent)
+      state.pending += '$'
     state.pos = start
     return true
   }
 
   // Check if we have empty content, ie: $$.  Do not parse.
   if (match - start === 0) {
-    if (!silent) state.pending += '$$'
+    if (!silent)
+      state.pending += '$$'
     state.pos = start + 1
     return true
   }
@@ -85,7 +90,8 @@ function math_inline(state: any, silent: boolean) {
   // Check for valid closing delimiter
   res = isValidDelim(state, match)
   if (!res.can_close) {
-    if (!silent) state.pending += '$'
+    if (!silent)
+      state.pending += '$'
     state.pos = start
     return true
   }
@@ -106,13 +112,16 @@ function math_block(state: any, start: number, end: number, silent: boolean) {
   let pos = state.bMarks[start] + state.tShift[start]
   let max = state.eMarks[start]
 
-  if (pos + 2 > max) return false
-  if (state.src.slice(pos, pos + 2) !== '$$') return false
+  if (pos + 2 > max)
+    return false
+  if (state.src.slice(pos, pos + 2) !== '$$')
+    return false
 
   pos += 2
   firstLine = state.src.slice(pos, max)
 
-  if (silent) return true
+  if (silent)
+    return true
   if (firstLine.trim().slice(-2) === '$$') {
     // Single line expression
     firstLine = firstLine.trim().slice(0, -2)
@@ -122,7 +131,8 @@ function math_block(state: any, start: number, end: number, silent: boolean) {
   for (next = start; !found;) {
     next++
 
-    if (next >= end) break
+    if (next >= end)
+      break
 
     pos = state.bMarks[next] + state.tShift[next]
     max = state.eMarks[next]

package/src/node/markdown/parseHeader.ts

@@ -48,8 +48,10 @@ export const removeNonCodeWrappedHTML = (str: string) => {
 }
 
 const compose = (...processors: ((str: string) => string)[]) => {
-  if (processors.length === 0) return (input: string) => input
-  if (processors.length === 1) return processors[0]
+  if (processors.length === 0)
+    return (input: string) => input
+  if (processors.length === 1)
+    return processors[0]
   return processors.reduce((prev, next) => {
     return str => next(prev(str))
   })

package/src/node/options.ts

@@ -16,6 +16,7 @@ export interface ValaxyEntryOptions {
 }
 
 export interface ResolvedValaxyOptions {
+  mode: 'dev' | 'build'
   /**
    * Client root path
    * @default 'valaxy/src/client'
@@ -69,7 +70,7 @@ export function getThemeRoot(name: string, entry: string) {
 }
 
 // for cli options
-export async function resolveOptions(options: ValaxyEntryOptions) {
+export async function resolveOptions(options: ValaxyEntryOptions, mode: ResolvedValaxyOptions['mode'] = 'dev') {
   const clientRoot = resolve(resolveImportPath('valaxy/package.json'), 'src/client')
   const userRoot = resolve(options.userRoot || process.cwd())
 
@@ -77,6 +78,7 @@ export async function resolveOptions(options: ValaxyEntryOptions) {
   const themeRoot = getThemeRoot(theme, userRoot)
 
   const valaxyOptions: ResolvedValaxyOptions = {
+    mode,
     clientRoot,
     userRoot,
     themeRoot,

package/src/node/plugins/index.ts

@@ -8,33 +8,58 @@ import type { ResolvedValaxyOptions, ValaxyServerOptions } from '../options'
 import { toAtFS } from '../utils'
 import { VALAXY_CONFIG_ID } from './valaxy'
 
-export function createValaxyPlugin(options: ResolvedValaxyOptions, serverOptions: ValaxyServerOptions = {}): Plugin {
-  const valaxyPrefix = '/@valaxy'
-
-  let valaxyConfig = options.config
+/**
+ * for /@valaxyjs/styles
+ * @param roots
+ * @returns
+ */
+function generateStyles(roots: string[]) {
+  const imports: string[] = []
+
+  for (const root of roots) {
+    const styles: string[] = []
+
+    const autoloadNames = ['index', 'css-vars']
+    autoloadNames.forEach((name) => {
+      styles.push(join(root, 'styles', `${name}.css`))
+      styles.push(join(root, 'styles', `${name}.scss`))
+    })
+
+    for (const style of styles) {
+      if (fs.existsSync(style))
+        imports.push(`import "${toAtFS(style)}"`)
+    }
+  }
+  return imports.join('\n')
+}
 
-  const roots = [options.userRoot, options.themeRoot]
+function generateLocales(roots: string[]) {
+  const imports: string[] = [
+    'const messages = { "zh-CN": {}, en: {} }',
+  ]
+  const languages = ['zh-CN', 'en']
+
+  roots.forEach((root, i) => {
+    languages.forEach((lang) => {
+      const langYml = `${root}/locales/${lang}.yml`
+      if (fs.existsSync(langYml)) {
+        const varName = lang.replace('-', '') + i
+        imports.push(`import ${varName} from "${langYml}"`)
+        imports.push(`Object.assign(messages['${lang}'], ${varName})`)
+      }
+    })
+  })
 
-  function generateUserStyles() {
-    const imports: string[] = []
+  imports.push('export default messages')
+  return imports.join('\n')
+}
 
-    for (const root of roots) {
-      const styles = [
-        join(root, 'styles', 'vars.scss'),
-        join(root, 'styles', 'index.css'),
-        join(root, 'styles', 'index.scss'),
-      ]
+export function createValaxyPlugin(options: ResolvedValaxyOptions, serverOptions: ValaxyServerOptions = {}): Plugin {
+  const valaxyPrefix = '/@valaxy'
 
-      for (const style of styles) {
-        if (fs.existsSync(style)) {
-          imports.push(`import "${toAtFS(style)}"`)
-          continue
-        }
-      }
-    }
+  let valaxyConfig = options.config
 
-    return imports.join('\n')
-  }
+  const roots = [options.clientRoot, options.themeRoot, options.userRoot]
 
   return {
     name: 'Valaxy',
@@ -60,7 +85,10 @@ export function createValaxyPlugin(options: ResolvedValaxyOptions, serverOptions
 
       // generate styles
       if (id === '/@valaxyjs/styles')
-        return generateUserStyles()
+        return generateStyles(roots)
+
+      if (id === '/@valaxyjs/locales')
+        return generateLocales(roots)
 
       if (id.startsWith(valaxyPrefix))
         return ''
@@ -69,7 +97,8 @@ export function createValaxyPlugin(options: ResolvedValaxyOptions, serverOptions
     async handleHotUpdate(ctx) {
       // handle valaxy.config.ts hmr
       const { file, server } = ctx
-      if (file !== options.configFile) return
+      if (file !== options.configFile)
+        return
 
       const { config } = await resolveConfig()
 

package/src/node/plugins/markdown.ts

@@ -47,7 +47,7 @@ export function createMarkdownPlugin(options: ResolvedValaxyOptions): Plugin[] {
     handleHotUpdate(ctx) {
       const { file, server } = ctx
       // send headers
-      if (file.endsWith('.md')) {
+      if (file.endsWith('.md') && _md && _md.__data) {
         server.ws.send({
           type: 'custom',
           event: 'valaxy:pageHeaders',