index.ts#

4 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.

4 symbols 3 functions 1 modules 4 parameters 3 returns 1 examples

Reference#

fngenerateVirtualModule(path: string, options: ResolvedOptions): stringGenerates virtual module content.2 paramsreturns string

Generates virtual module content.

Signature

export function generateVirtualModule(path: string, options: ResolvedOptions): string

View source

Parameters

path string
options ResolvedOptions

Returns

string

moduleindexVite Plugin for Ox Content Uses Vite's Environment API for SSG-focused Markdown processing. Provides separate environme…

Vite Plugin for Ox Content

Uses Vite's Environment API for SSG-focused Markdown processing. Provides separate environments for client and server rendering.

View source

fnoxContent(options: OxContentOptions = {}): Plugin[]Creates the Ox Content Vite plugin.1 paramreturns Plugin[]1 example

Creates the Ox Content Vite plugin.

Signature

export function oxContent(options: OxContentOptions = {}): Plugin[]

View source

Parameters

options OxContentOptions

optional · default: {}

Returns

Plugin[]

Examples

Example 1

// vite.config.ts
import { defineConfig } from 'vite';
import { oxContent } from '@ox-content/vite-plugin';

export default defineConfig({
  plugins: [
    oxContent({
      srcDir: 'content',
      gfm: true,
    }),
  ],
});

fnresolveOptions(options: OxContentOptions): ResolvedOptionsResolves plugin options with defaults.1 paramreturns ResolvedOptions

Resolves plugin options with defaults.

Signature

function resolveOptions(options: OxContentOptions): ResolvedOptions

View source

Parameters

options OxContentOptions

Returns

ResolvedOptions