Theme Press

TIP

Type definitions: valaxy-theme-press/types/index.d.ts

valaxy-theme-press is the official documentation theme for Valaxy. It is inspired by VitePress, but it runs on Valaxy’s routing, Markdown, addon, i18n, and blog data systems.

Use it when your site is primarily documentation, a project handbook, a knowledge base, or a docs site that still needs Valaxy features such as posts, categories, tags, addons, and custom Vue components.

Quick Start ​

The easiest path is to choose Press when creating a new Valaxy site:

bash
pnpm create valaxy

For an existing Valaxy site, install the theme and set theme to press:

bash
pnpm add valaxy-theme-press
valaxy.config.ts
ts
import type { PressTheme } from 'valaxy-theme-press'
import { defineValaxyConfig } from 'valaxy'

export default defineValaxyConfig<PressTheme.Config>({
  theme: 'press',
  themeConfig: {
    logo: '/favicon.svg',
  },
})

You can also move theme options into theme.config.ts:

theme.config.ts
ts
import { defineThemeConfig } from 'valaxy-theme-press'

export default defineThemeConfig({
  logo: '/favicon.svg',
})

Documentation Map ​

Minimal Docs Site ​

A practical documentation site usually configures site metadata, search, navigation, a sidebar, edit links, and footer text:

valaxy.config.ts
ts
import type { PressTheme } from 'valaxy-theme-press'
import { defineValaxyConfig } from 'valaxy'

export default defineValaxyConfig<PressTheme.Config>({
  siteConfig: {
    title: 'Acme Docs',
    url: 'https://docs.example.com',
    description: 'Documentation for Acme',
    search: {
      enable: true,
      provider: 'local',
    },
    lastUpdated: true,
  },

  theme: 'press',
  themeConfig: {
    logo: '/favicon.svg',
    nav: [
      { text: 'Guide', link: '/guide/getting-started' },
      { text: 'API', link: '/api/' },
    ],
    sidebar: {
      '/guide/': {
        base: '/guide/',
        items: [
          {
            text: 'Guide',
            items: [
              { text: 'Getting Started', link: 'getting-started' },
              { text: 'Configuration', link: 'config' },
            ],
          },
        ],
      },
    },
    editLink: {
      pattern: 'https://github.com/acme/project/edit/main/docs/:path',
      text: 'Edit this page',
    },
    footer: {
      message: 'Released under the MIT License.',
      copyright: 'Copyright (c) 2026 Acme.',
    },
  },
})

The Valaxy documentation itself is the largest real-world example of Press. See docs/valaxy.config.ts for a complete configuration.

Contributors