-
Notifications
You must be signed in to change notification settings - Fork 146
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: unify title capitalization style (#1742)
- Loading branch information
1 parent
5612c87
commit c3e1624
Showing
105 changed files
with
266 additions
and
261 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
@@ -41,7 +41,7 @@ nvm use 18 | |
corepack enable | ||
``` | ||
|
||
### Install Dependencies | ||
### Install dependencies | ||
|
||
```sh | ||
pnpm install | ||
|
@@ -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. | ||
|
||
|
@@ -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: | ||
|
||
|
@@ -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: | ||
|
||
|
@@ -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: | ||
|
||
|
@@ -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. | ||
|
||
|
@@ -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/). | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,4 +2,4 @@ | |
context: 'context-index-in-meta' | ||
--- | ||
|
||
# Index In Meta | ||
# Index in meta |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,4 +2,4 @@ | |
context: 'context-index-md-convention' | ||
--- | ||
|
||
# Index Md Convention | ||
# Index md convention |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,4 +2,4 @@ | |
context: 'context-index-mdx-convention' | ||
--- | ||
|
||
# Index Mdx Convention | ||
# Index MDX convention |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,4 +2,4 @@ | |
context: 'context-no-meta-md' | ||
--- | ||
|
||
# No Meta Md | ||
# No meta md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,4 +2,4 @@ | |
context: 'context-no-meta-mdx' | ||
--- | ||
|
||
# No Meta Mdx | ||
# No meta MDX |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,4 +2,4 @@ | |
context: 'context-same-name' | ||
--- | ||
|
||
# Same Name Outer Page | ||
# Same name outer page |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
# Hello World | ||
# Hello world |
2 changes: 1 addition & 1 deletion
2
e2e/fixtures/auto-nav-sidebar-no-meta/doc/api/plugin/plugin-a.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
2 changes: 1 addition & 1 deletion
2
e2e/fixtures/auto-nav-sidebar-no-meta/doc/api/plugin/plugin-b.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
# Plugin B | ||
# Plugin b |
2 changes: 1 addition & 1 deletion
2
e2e/fixtures/auto-nav-sidebar-no-meta/doc/api/rspress-config/config-basic.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Basic Config | ||
# Basic config | ||
|
||
## root | ||
|
||
|
4 changes: 2 additions & 2 deletions
4
e2e/fixtures/auto-nav-sidebar-no-meta/doc/api/rspress-config/config-build.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
# Build Config | ||
# Build config | ||
|
||
## builderConfig | ||
|
||
### Default Config | ||
### Default config | ||
|
||
## markdown | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
overviewHeaders: [] | ||
--- | ||
|
||
# Front Matter Config | ||
# Front matter config | ||
|
||
## title | ||
|
||
|
2 changes: 1 addition & 1 deletion
2
e2e/fixtures/auto-nav-sidebar-no-meta/doc/api/rspress-config/config-theme.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Theme Config | ||
# Theme config | ||
|
||
## nav | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Basic Config | ||
# Basic config | ||
|
||
## root | ||
|
||
|
4 changes: 2 additions & 2 deletions
4
e2e/fixtures/auto-nav-sidebar/doc/api/config/config-build.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
# Build Config | ||
# Build config | ||
|
||
## builderConfig | ||
|
||
### Default Config | ||
### Default config | ||
|
||
## markdown | ||
|
||
|
2 changes: 1 addition & 1 deletion
2
e2e/fixtures/auto-nav-sidebar/doc/api/config/config-extname.json.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
# Extname Config | ||
# Extname config |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,7 +3,7 @@ overviewHeaders: [] | |
context: 'front-matter' | ||
--- | ||
|
||
# Front Matter Config | ||
# Front matter config | ||
|
||
## title | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Theme Config | ||
# Theme config | ||
|
||
## nav | ||
|
||
|
2 changes: 1 addition & 1 deletion
2
e2e/fixtures/auto-nav-sidebar/doc/api/config/nested/config-nested.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Nested Config | ||
# Nested config | ||
|
||
## Nested H2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
# Hello World | ||
# Hello world |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Hello World | ||
# Hello world | ||
|
||
:::tip TIP | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
# Hello World | ||
# Hello world |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,6 @@ head: | |
content: custom-meta-content-2 | ||
--- | ||
|
||
# Hello World | ||
# Hello world | ||
|
||
World Hello |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,6 +2,6 @@ | |
pageType: home | ||
--- | ||
|
||
# Hello World | ||
# Hello world | ||
|
||
hello |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
# Hello World | ||
# Hello world |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
# Hello World | ||
# Hello world |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
# Hello World | ||
# Hello world |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# modern-js | ||
|
||
## Get Started | ||
## Get started | ||
|
||
按开发环境的要求,运行和调试项目 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Components Overview | ||
# Components overview | ||
|
||
<Overview | ||
list={[ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
# Hello World | ||
# Hello world |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
# Hello World | ||
# Hello world |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Hello World | ||
# Hello world | ||
|
||
hello |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Hello World | ||
# Hello world | ||
|
||
## API | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
# Hello World | ||
# Hello world |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
# Hello World | ||
# Hello world |
Oops, something went wrong.