Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: unify title capitalization style #1742

Merged
merged 3 commits into from
Jan 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributor Covenant Code of Conduct
# Contributor covenant code of conduct

## Our Pledge
## Our pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
Expand All @@ -12,7 +12,7 @@ and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards
## Our standards

Examples of behavior that contributes to a positive environment for our
community include:
Expand All @@ -36,7 +36,7 @@ Examples of unacceptable behavior include:
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
## Enforcement responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
Expand Down Expand Up @@ -65,7 +65,7 @@ All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines
## Enforcement guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
Expand All @@ -91,7 +91,7 @@ includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban
### 3. Temporary ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
Expand All @@ -102,7 +102,7 @@ private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban
### 4. Permanent ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
Expand Down
26 changes: 13 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Contributing Guide
# Contributing guide

Thanks for that you are interested in contributing to Rspress. Before starting your contribution, please take a moment to read the following guidelines.

---

## Setup the Dev Environment
## Setup the dev environment

### Fork the Repo
### Fork the repo

[Fork](https://help.github.com/articles/fork-a-repo/) this repository to your
own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local.
Expand Down Expand Up @@ -41,7 +41,7 @@ nvm use 18
corepack enable
```

### Install Dependencies
### Install dependencies

```sh
pnpm install
Expand All @@ -53,7 +53,7 @@ What this will do:
- Create symlinks between packages in the monorepo
- Run the `build` script to build all packages (this will take some time, but is necessary to make ensure all packages are built)

### Set Git Email
### Set git email

Please make sure you have your email set up in `<https://github.com/settings/emails>`. This will be needed later when you want to submit a pull request.

Expand All @@ -77,19 +77,19 @@ git config user.email "[email protected]"

---

## Making Changes and Building
## Making changes and building

Once you have set up the local development environment in your forked repo, we can start development.

### Checkout A New Branch
### Checkout a new branch

It is recommended to develop on a new branch, as it will make things easier later when you submit a pull request:

```sh
git checkout -b MY_BRANCH_NAME
```

### Build the Package
### Build the package

To build the package you want to change, first open the package directory, then run the `build` command:

Expand Down Expand Up @@ -117,7 +117,7 @@ If you need to clean all `node_modules/*` in the project, run the `reset` comman
pnpm run reset
```

### Debug Code
### Debug code

After `build`, we need to link this repo to the global, run the link command:

Expand All @@ -143,7 +143,7 @@ pnpm run dev

## Testing

### Run Unit Tests
### Run unit tests

Before submitting a pull request, it's important to make sure that the changes haven't introduced any regressions or bugs. You can run the unit tests for the project by executing the following command:

Expand All @@ -157,7 +157,7 @@ Alternatively, you can run the unit tests of single package using the `--filter`
pnpm run --filter rspress test
```

### Run E2E Tests
### Run E2E tests

In addition to the unit tests, the Rspress also includes end-to-end (E2E) tests, which checks the functionality of the application as a whole.

Expand All @@ -181,9 +181,9 @@ pnpm run lint

---

## Submitting Changes
## Submitting changes

### Committing your Changes
### Committing your changes

Commit your changes to your forked repo, and [create a pull request](https://help.github.com/articles/creating-a-pull-request/).

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ A fast Rspack-based static site generator.
- **🔌 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.

## 📚 Getting Started
## 📚 Getting started

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

Expand Down Expand Up @@ -79,7 +79,7 @@ If you have any questions, you can open an issue or go to [Discord](https://disc
</table>
</a>

### Code of Conduct
### 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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
context: 'context-index-in-meta'
---

# Index In Meta
# Index in meta
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
context: 'context-index-md-convention'
---

# Index Md Convention
# Index md convention
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
context: 'context-index-mdx-convention'
---

# Index Mdx Convention
# Index MDX convention
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
context: 'context-no-meta-md'
---

# No Meta Md
# No meta md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
context: 'context-no-meta-mdx'
---

# No Meta Mdx
# No meta MDX
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
context: 'context-same-name'
---

# Same Name Outer Page
# Same name outer page
2 changes: 1 addition & 1 deletion e2e/fixtures/auto-nav-sidebar-dir-convention/doc/index.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Hello World
# Hello world
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Plugin A
# Plugin a

this directory has no meta and no index.mdx, should use directory name
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Plugin B
# Plugin b
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Basic Config
# Basic config

## root

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Build Config
# Build config

## builderConfig

### Default Config
### Default config

## markdown

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
overviewHeaders: []
---

# Front Matter Config
# Front matter config

## title

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Theme Config
# Theme config

## nav

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Basic Config
# Basic config

## root

Expand Down
4 changes: 2 additions & 2 deletions e2e/fixtures/auto-nav-sidebar/doc/api/config/config-build.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Build Config
# Build config

## builderConfig

### Default Config
### Default config

## markdown

Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Extname Config
# Extname config
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ overviewHeaders: []
context: 'front-matter'
---

# Front Matter Config
# Front matter config

## title

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Theme Config
# Theme config

## nav

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Nested Config
# Nested config

## Nested H2
2 changes: 1 addition & 1 deletion e2e/fixtures/auto-nav-sidebar/doc/index.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Hello World
# Hello world
2 changes: 1 addition & 1 deletion e2e/fixtures/basic/doc/index.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hello World
# Hello world

:::tip TIP

Expand Down
2 changes: 1 addition & 1 deletion e2e/fixtures/client-redirects/doc/index.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Hello World
# Hello world
2 changes: 1 addition & 1 deletion e2e/fixtures/custom-headers/doc/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ head:
content: custom-meta-content-2
---

# Hello World
# Hello world

World Hello
2 changes: 1 addition & 1 deletion e2e/fixtures/custom-home-footer/doc/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
pageType: home
---

# Hello World
# Hello world

hello
2 changes: 1 addition & 1 deletion e2e/fixtures/custom-icon/doc/index.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Hello World
# Hello world
2 changes: 1 addition & 1 deletion e2e/fixtures/custom-layout-ui-switch/doc/index.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Hello World
# Hello world
2 changes: 1 addition & 1 deletion e2e/fixtures/github-alert-mdxjs/doc/index.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hello World
# Hello world

> [!TIP]
> This is a 'tip' style block.
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
@@ -1,4 +1,4 @@
# Hello World
# Hello world

> [!TIP]
> This is a 'tip' style block.
Expand Down
2 changes: 1 addition & 1 deletion e2e/fixtures/i18n/doc/en/guide/basic/quick-start.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Quick Start
# Quick start

[click by absolute path](/guide/basic/install) to go to install

Expand Down
2 changes: 1 addition & 1 deletion e2e/fixtures/link/doc/index.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Hello World
# Hello world
2 changes: 1 addition & 1 deletion e2e/fixtures/mdx-rs/doc/en/guide/quick-start.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Quick Start
# Quick start

[click by absolute path](/guide/install) to go to install

Expand Down
2 changes: 1 addition & 1 deletion e2e/fixtures/modern-js/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# modern-js

## Get Started
## Get started

按开发环境的要求,运行和调试项目

Expand Down
2 changes: 1 addition & 1 deletion e2e/fixtures/modern-js/docs/en/index.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Components Overview
# Components overview

<Overview
list={[
Expand Down
2 changes: 1 addition & 1 deletion e2e/fixtures/nav-link-items-without-suffix/doc/index.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Hello World
# Hello world
2 changes: 1 addition & 1 deletion e2e/fixtures/nav-link-items/doc/index.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Hello World
# Hello world
2 changes: 1 addition & 1 deletion e2e/fixtures/no-config-root/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Hello World
# Hello world

hello
6 changes: 3 additions & 3 deletions e2e/fixtures/package-manager-tabs/doc/index.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { PackageManagerTabs } from '@theme';

# Hello World
# Hello world

## PackageManagerTabs A
## PackageManagerTabs a

<PackageManagerTabs command="create rspress@latest" />

## PackageManagerTabs B
## PackageManagerTabs b

<PackageManagerTabs command="install rspress -D" />
2 changes: 1 addition & 1 deletion e2e/fixtures/plugin-api-docgen/doc/index.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hello World
# Hello world

## API

Expand Down
2 changes: 1 addition & 1 deletion e2e/fixtures/plugin-typedoc/multi/doc/index.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Hello World
# Hello world
2 changes: 1 addition & 1 deletion e2e/fixtures/plugin-typedoc/single/doc/index.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Hello World
# Hello world
Loading
Loading