close
Rspress
Search
Guide
Plugin
UI
new
API
Version
Changelog
Rspress 1.x Doc
English
中文
English
Theme
Languages
English
中文
English
Menu
ON THIS PAGE
API Overview
#
Filter
Config
#
Basic config
root
base
title
description
icon
lang
i18nSource
logo
logoText
outDir
locales
head
mediumZoom
search
globalUIComponents
multiVersion
route
ssg
replaceRules
languageParity
Theme config
nav
sidebar
footer
socialLinks
nextPageText
locales
darkMode
editLink
enableContentAnimation
enableAppearanceAnimation
search
enableScrollToTop
localeRedirect
fallbackHeadingTitle
Front matter config
title
description
pageType
titleSuffix
head
hero
features
sidebar
outline
footer
navbar
overviewHeaders
context
Build config
builderConfig
builderConfig.plugins
markdown
Client API
#
Runtime API
usePageData
useLang
useVersion
useDark
useI18n
Router hook
Built-in components
Badge
Head
HomeFeature
HomeHero
LastUpdated
NoSSR
Overview
PackageManagerTabs
PrevNextPage
SourceCode
Steps
Tab/Tabs
CodeBlockRuntime
Commands
#
Commands
rspress dev
rspress build
rspress preview
