CtrlK
BlogDocsLog inGet started
Tessl Logo

tessl/npm-slidev--types

Comprehensive TypeScript type definitions and interfaces for the Slidev presentation framework ecosystem

Pending
Overview
Eval results
Files

options-system.mddocs/

Options and Configuration System

Core configuration interfaces for Slidev server options, entry configuration, and resolved utilities.

Capabilities

Roots Information

Configuration interface for Slidev runtime roots and workspace information.

/**
 * Roots information for Slidev runtime environment
 */
interface RootsInfo {
  /** CLI package root directory */
  cliRoot: string;
  /** Client package root directory */
  clientRoot: string;
  /** User project root directory */
  userRoot: string;
  /** User package.json contents */
  userPkgJson: Record<string, any>;
  /** User workspace root directory */
  userWorkspaceRoot: string;
}

Slidev Entry Options

Configuration options for Slidev entry and initialization.

/**
 * Configuration options for Slidev entry
 */
interface SlidevEntryOptions {
  /** Markdown entry file path */
  entry: string;
  /** Theme identifier to use */
  theme?: string;
  /** Remote password for remote presentations */
  remote?: string;
  /** Enable inspect plugin for debugging */
  inspect?: boolean;
  /** Build with download option enabled */
  download?: boolean;
  /** Base URL for dev or build mode */
  base?: string;
}

Resolved Slidev Options

Comprehensive resolved options combining all configuration aspects.

/**
 * Fully resolved Slidev configuration options
 */
interface ResolvedSlidevOptions extends RootsInfo, SlidevEntryOptions {
  /** Parsed slide data */
  data: SlidevData;
  /** Raw theme identifier string */
  themeRaw: string;
  /** Theme root directories */
  themeRoots: string[];
  /** Addon root directories */
  addonRoots: string[];
  /** Combined roots array (excludes clientRoot) */
  roots: string[];
  /** Current mode: development, build, or export */
  mode: 'dev' | 'build' | 'export';
  /** Resolved utilities and tools */
  utils: ResolvedSlidevUtils;
}

Resolved Slidev Utilities

Utility interfaces and tools available in resolved Slidev configuration.

/**
 * Resolved utilities for Slidev operations
 */
interface ResolvedSlidevUtils {
  /** Shiki syntax highlighter instance */
  shiki: HighlighterGeneric<any, any>;
  /** Shiki configuration options */
  shikiOptions: MarkdownItShikiOptions;
  /** KaTeX configuration options (null if disabled) */
  katexOptions: KatexOptions | null;
  /** Base HTML template string */
  indexHtml: string;
  /** Vite define configuration */
  define: Record<string, string>;
  /** Icon resolution paths */
  iconsResolvePath: string[];
  /** Function to check if Monaco types should be ignored for a package */
  isMonacoTypesIgnored: (pkg: string) => boolean;
  /** Function to get available layout components */
  getLayouts: () => Record<string, string>;
}

Server Options

Configuration options for Slidev development server.

/**
 * Slidev server configuration options
 */
interface SlidevServerOptions {
  /** 
   * Custom data loading function
   * @returns false if server should be restarted
   */
  loadData?: (loadedSource: Record<string, string>) => Promise<SlidevData | false>;
}

Types

import type { MarkdownItShikiOptions } from '@shikijs/markdown-it';
import type { KatexOptions } from 'katex';
import type { HighlighterGeneric } from 'shiki';
import type { SlidevData } from './types';

Install with Tessl CLI

npx tessl i tessl/npm-slidev--types

docs

cli-build.md

clicks-interactions.md

code-execution.md

config-frontmatter.md

context-menu.md

index.md

markdown-transform.md

options-system.md

setup-plugins.md

slide-data.md

table-of-contents.md

tile.json