English

English

Config

Front Matter Config

Client API

Internal Components

Overview

Config

Basic Config

base
title
description
icon
logo
outDir
locales
mediumZoom
search
globalUIComponents
multiVersion
route

Theme Config

nav
sidebar
footer
outlineTitle
lastUpdated
lastUpdatedText
prevPageText
socialLinks
nextPageText
locales
darkMode
hideNavbar
enableContentAnimation

Front Matter Config

title
description
pageType
hero
features
sidebar
outline
footer
navbar

Build Config

builderConfig
builderPlugins
markdown

Client API

Runtime API

usePageData
useLang
useVersion
useDark
useI18n
Router Hook

Internal Components

NoSSR
Tab/Tabs
PackageManagerTabs
Table of Contents

Others

API Overview

Commands

rspress dev
rspress build
rspress preview