Skip to content

Commit

Permalink
docs: update README and introduction files (#1835)
Browse files Browse the repository at this point in the history
  • Loading branch information
chenjiahan authored Feb 11, 2025
1 parent 6d35de5 commit 2f2aed6
Show file tree
Hide file tree
Showing 11 changed files with 25 additions and 52 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<picture>
<img alt="Rspress Banner" src="https://github.com/web-infra-dev/rspress/assets/39261479/999e7946-45ff-45d5-b9cd-594e634e0e5a">
<img alt="Rspress Banner" src="https://assets.rspack.dev/rspress/rspress-banner.png">
</picture>

# Rspress

A fast Rspack-based static site generator.
A fast Rsbuild-based static site generator.

<p>
<a href="https://discord.gg/mkVw5zPAtf"><img src="https://img.shields.io/badge/chat-discord-blue?logo=discord&colorA=564341&colorB=EDED91" alt="discord channel" /></a>
Expand All @@ -15,7 +15,7 @@ A fast Rspack-based static site generator.

## 🔥 Features

- **🚀 Fast Startup**: Based on Rust-based build tool and markdown/mdx compiler, the build speed is extremely fast, bringing you the ultimate development experience.
- **🚀 Fast Startup**: Based on Rsbuild and MDX compiler, the build speed is extremely fast, bringing you the ultimate development experience.
- **📚 MDX Support**: MDX is a powerful way to write content, allowing you to use React components in Markdown.
- **📦 Built-in Full Text Search**: Automatically generates a full-text search index for you during building process, providing out-of-the-box full-text search capabilities.
- **🌈 Static Site Generation**: In production, it automatically builds into static HTML files, which can be easily deployed anywhere.
Expand All @@ -24,7 +24,7 @@ A fast Rspack-based static site generator.

## 📚 Getting started

Go to the [Quick Start](https://rspress.dev/guide/start/getting-started.html) to get started.
Go to the [Quick start](https://rspress.dev/guide/start/getting-started.html) to get started.

## 🤝 Contribution

Expand Down Expand Up @@ -91,7 +91,7 @@ This repo has adopted the ByteDance Open Source Code of Conduct. Please check [C
| [Rspack](https://github.com/web-infra-dev/rspack) | A fast Rust-based web bundler. |
| [Rsbuild](https://github.com/web-infra-dev/rsbuild) | An Rspack-based build tool for the web. |
| [Rslib](https://github.com/web-infra-dev/rslib) | A library development tool powered by Rsbuild. |
| [Rsdoctor](https://github.com/web-infra-dev/rsdoctor) | A one-stop build analyzer for Rspack and Webpack. |
| [Rsdoctor](https://github.com/web-infra-dev/rsdoctor) | A one-stop build analyzer for Rspack and webpack. |

## 🌟 Quality

Expand Down
2 changes: 1 addition & 1 deletion e2e/fixtures/github-alert-mdxjs/doc/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import { Steps } from '@theme';
> > Nested blockquote
> ![Image Alt Text](https://github.com/web-infra-dev/rspress/assets/39261479/999e7946-45ff-45d5-b9cd-594e634e0e5a)
> ![Image Alt Text](https://assets.rspack.dev/rspress/rspress-banner.png)
1. Title
Expand Down
2 changes: 1 addition & 1 deletion e2e/fixtures/github-alert-mdxrs/doc/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import { Steps } from '@theme';
> > Nested blockquote
> ![Image Alt Text](https://github.com/web-infra-dev/rspress/assets/39261479/999e7946-45ff-45d5-b9cd-594e634e0e5a)
> ![Image Alt Text](https://assets.rspack.dev/rspress/rspress-banner.png)
1. Title
Expand Down
35 changes: 4 additions & 31 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,15 @@
# Rspress

<picture>
<img alt="Rspress Banner" src="https://github.com/web-infra-dev/rspress/assets/39261479/999e7946-45ff-45d5-b9cd-594e634e0e5a">
<img alt="Rspress Banner" src="https://assets.rspack.dev/rspress/rspress-banner.png">
</picture>

<h2 align="center">A fast Rspack-based static site generator.</h2>

## Features

- **🚀 Fast Startup**: Based on Rust-based build tool and markdown/mdx compiler, the build speed is extremely fast, bringing you the ultimate development experience.
- **📚 MDX Support**: MDX is a powerful way to write content, allowing you to use React components in Markdown.
- **📦 Built-in Full Text Search**: Automatically generates a full-text search index for you during building process, providing out-of-the-box full-text search capabilities.
- **🌈 Static Site Generation**: In production, it automatically builds into static HTML files, which can be easily deployed anywhere.
- **🔌 Providing Plugin System**: Providing a plugin system, you can customize the build process and theme according to your needs.
- **📝 Component Document**: Support multi ways to preview your component demo.
<h2 align="center">A fast Rsbuild-based static site generator.</h2>

## Getting started

Go to the [Quick Start](https://rspress.dev/guide/start/getting-started.html) to get started.

## Contribution

Please read the [contributing guide](./CONTRIBUTING.md) and let's build Rspress together.

If you have any questions, you can open an issue or go to [Discord](https://discord.com/invite/Cq6HweJM26) to communicate with us.

### Code of conduct

This repo has adopted the ByteDance Open Source Code of Conduct. Please check [Code of Conduct](./CODE_OF_CONDUCT.md) for more details.

### Links

| Name | Description |
| ---------------------------------------------------------- | --------------------------------------- |
| [@rspress/mdx-rs](https://github.com/web-infra-dev/mdx-rs) | Rust MDX compiler for Rspress. |
| [Rspack](https://github.com/web-infra-dev/rspack) | A fast Rust-based web bundler. |
| [Rsbuild](https://github.com/web-infra-dev/rsbuild) | An Rspack-based build tool for the web. |
Go to the [Quick start](https://rspress.dev/guide/start/getting-started.html) to get started.

### License

Rspress is licensed under the [MIT License](./LICENSE).
Rspress is licensed under the MIT License.
4 changes: 2 additions & 2 deletions packages/document/docs/en/api/config/config-frontmatter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ Set the suffix of the page title. When `titleSuffix` is not set, the site's [tit

```yaml
---
titleSuffix: 'Rspack-based Static Site Generator'
titleSuffix: 'Rsbuild-based Static Site Generator'
---
```

The default separator between the title and the suffix is `-`, you can also use `|` for separation:

```yaml
---
titleSuffix: '| Rspack-based Static Site Generator'
titleSuffix: '| Rsbuild-based Static Site Generator'
---
```

Expand Down
8 changes: 4 additions & 4 deletions packages/document/docs/en/guide/start/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

Rspress is a static site generator based on [Rsbuild](https://rsbuild.dev/), rendered with the React framework. It comes with a default documentation theme, and you can quickly build a documentation site with Rspress. You can also customize the theme to meet your personalized static site needs, such as blog sites, product homepages, etc. Of course, you can also integrate the corresponding plugins provided by the official to easily build component library documentation.

## Project background
## Why Rspress

Rspress is mainly built in the following directions:
Rspress is designed around the following core features:

- **Build Performance**. Ensuring a fast enough startup speed brings a good development experience.
- **MDX Support**. Through MDX, we can conveniently reuse document fragments and render custom React components in documents.
- **Basic Capabilities of Documentation Site**. Including internationalization, multi-version support, full-text search, component library documentation, etc.
- **Extensibility**. Such as Built-in plugin system, supports extending framework functions through plugin API.

These also represent some core requirements for SSG site development. The following will introduce these aspects separately.
These also represent some core requirements for static site development. The following will introduce these aspects separately.

### Build performance

Expand Down Expand Up @@ -295,4 +295,4 @@ export default defineConfig({

## Try Rspress

Go to [Quick Start](/guide/start/getting-started) to learn how to use Rspress to quickly build a documentation site.
Go to [Quick start](/guide/start/getting-started) to learn how to use Rspress to quickly build a documentation site.
2 changes: 1 addition & 1 deletion packages/document/docs/en/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
pageType: home
titleSuffix: 'Rspack-based Static Site Generator'
titleSuffix: 'Rsbuild-based Static Site Generator'

hero:
name: Rspress
Expand Down
4 changes: 2 additions & 2 deletions packages/document/docs/zh/api/config/config-frontmatter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ import PageType from '@zh/fragments/page-type';

```yaml
---
titleSuffix: '基于 Rspack 的静态站点生成器'
titleSuffix: '基于 Rsbuild 的静态站点生成器'
---
```

标题与后缀之间默认使用 `-` 作为分隔符,你也可以使用 `|` 进行分隔:

```yaml
---
titleSuffix: '| 基于 Rspack 的静态站点生成器'
titleSuffix: '| 基于 Rsbuild 的静态站点生成器'
---
```

Expand Down
6 changes: 3 additions & 3 deletions packages/document/docs/zh/guide/start/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

Rspress 是一个基于 [Rsbuild](https://rsbuild.dev/) 的静态站点生成器,基于 React 框架进行渲染,内置了一套默认的文档主题,你可以通过 Rspress 来快速搭建一个文档站点,同时也可以自定义主题,来满足你的个性化静态站需求,比如博客站、产品主页等。当然,你也可以接入官方提供的相应插件来方便地搭建组件库文档。

## 项目背景
## 为什么选择 Rspress

Rspress 主要以如下的几个方向来进行建设
Rspress 主要围绕以下几个核心特性进行设计

- **构建性能**。保证足够快的启动速度,带来良好的开发体验。
- **MDX 支持**。通过 MDX,我们可以方便地复用文档片段,以及在文档中渲染自定义的 React 组件。
- **文档站基础能力**。包括国际化、多版本支持、全文搜索、组件库文档等。
- **可扩展性**。内置插件系统,支持通过插件 API 来扩展框架功能。

这些也代表了 SSG 站点开发的一些核心需求。接下来将会根据这几个方面分别进行介绍。
这些也代表了静态站点开发的一些核心需求。接下来将会根据这几个方面分别进行介绍。

### 构建性能

Expand Down
2 changes: 1 addition & 1 deletion packages/document/docs/zh/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
pageType: home
titleSuffix: '基于 Rspack 的静态站点生成器'
titleSuffix: '基于 Rsbuild 的静态站点生成器'

hero:
name: Rspress
Expand Down
2 changes: 1 addition & 1 deletion packages/modern-plugin-rspress/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## Getting started

Please follow [Quick Start](https://modernjs.dev/en/guides/get-started/quick-start) to get started with Modern.js.
Please follow [Quick start](https://modernjs.dev/en/guides/get-started/quick-start) to get started with Modern.js.

## Documentation

Expand Down

0 comments on commit 2f2aed6

Please sign in to comment.