close
logo
Rspress
指南
插件
API
更新日志
Rspress 2.x 文档
简体中文
English
指南
插件
API
更新日志
Rspress 2.x 文档
简体中文
English
logo
Rspress
API 概览

配置

基础配置
主题配置
Front matter 配置
构建配置

Client API

Runtime API
内置组件
命令

API 概览

配置

基础配置

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

主题配置

  • 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 配置

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

构建配置

  • builderConfig
  • builderPlugins
  • markdown

Client API

Runtime API

  • usePageData
  • useLang
  • useVersion
  • useDark
  • useI18n
  • 路由 Hook

内置组件

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

命令

命令

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