close
logo
Rspress
Guide
Plugin
API
Changelog
Rspress 2.x Doc
简体中文
English
Guide
Plugin
API
Changelog
Rspress 2.x Doc
简体中文
English
logo
Rspress
API Overview

Config

Basic config
Theme config
Front matter config
Build config

Client API

Runtime API
Built-in components
Commands

API Overview

Config

Basic config

  • root
  • base
  • title
  • description
  • icon
  • lang
  • logo
  • logoText
  • outDir
  • locales
  • head
  • mediumZoom
  • search
  • globalUIComponents
  • multiVersion
  • route
  • ssg
  • replaceRules
  • languageParity

Theme config

  • nav
  • sidebar
  • footer
  • outlineTitle
  • lastUpdated
  • lastUpdatedText
  • prevPageText
  • searchPlaceholderText
  • searchNoResultsText
  • searchSuggestedQueryText
  • overview
  • socialLinks
  • nextPageText
  • locales
  • darkMode
  • hideNavbar
  • enableContentAnimation
  • enableAppearanceAnimation
  • search
  • sourceCodeText
  • enableScrollToTop
  • localeRedirect
  • fallbackHeadingTitle

Front matter config

  • title
  • description
  • pageType
  • titleSuffix
  • head
  • hero
  • features
  • sidebar
  • outline
  • footer
  • navbar
  • overviewHeaders
  • context

Build config

  • builderConfig
  • builderPlugins
  • markdown

Client API

Runtime API

  • usePageData
  • useLang
  • useVersion
  • useDark
  • useI18n
  • Router hook

Built-in components

  • Badge
  • Card
  • LinkCard
  • Helmet
  • HomeFeature
  • HomeHero
  • LastUpdated
  • NoSSR
  • Overview
  • PackageManagerTabs
  • PrevNextPage
  • SourceCode
  • Steps
  • Tab/Tabs
  • Table of contents

Commands

Commands

  • rspress dev
  • rspress build
  • rspress preview
  • rspress update