English

English

Config

Front Matter Config

Client API

Built-in Components

API Overview

Filter

Config

Basic Config

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

Theme Config

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

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