You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/README.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Rspack Documentation
1
+
# Rspack documentation
2
2
3
3
📄 Documentation for Rspack.
4
4
@@ -21,7 +21,13 @@ The source code of Rspress can be found in [this folder](https://github.com/web-
21
21
22
22
If you have any problems using the Rspress, please create a new issue at [Rspress Issues](https://github.com/web-infra-dev/rspress/issues).
23
23
24
-
## Image Assets
24
+
## Writing style guide
25
+
26
+
-**Capitalization style**: page titles and section headings should use sentence-style capitalization (only capitalize the first word and proper nouns) rather than title-style capitalization:
27
+
- Correct: "A new method for creating JavaScript rollovers"
28
+
- Incorrect: "A New Method for Creating JavaScript Rollovers"
29
+
30
+
## Image assets
25
31
26
32
For images you use in the document, it's better to upload them to the [rspack-contrib/rstack-design-resources](https://github.com/rspack-contrib/rstack-design-resources) repository, so the size of the current repository doesn't get too big.
Copy file name to clipboardExpand all lines: website/docs/en/api/cli.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Command Line Interface (CLI)
1
+
# Command line interface (CLI)
2
2
3
3
[@rspack/cli](https://npmjs.com/package/@rspack/cli) provides two common subcommands, serve and build, to simplify daily work. If you do not have @rspack/cli installed, please read the [Quick Start](/guide/start/quick-start) section first.
Copy file name to clipboardExpand all lines: website/docs/en/api/index.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ The Command Line Interface (CLI) to configure and interact with your build. It i
10
10
11
11
## Runtime API
12
12
13
-
When processing modules with rspack, it is important to understand the different module syntaxes – specifically the methods and variables - that are supported. And also the runtime Hot Module Replacement (HMR) improves the development experience by updating modules in the browser at runtime without needing a whole page refresh.
13
+
When processing modules with rspack, it is important to understand the different module syntaxes – specifically the methods and variables - that are supported. And also the runtime HMR improves the development experience by updating modules in the browser at runtime without needing a whole page refresh.
14
14
15
15
[Learn more about the Runtime API!](/api/runtime-api/module-methods)
Copy file name to clipboardExpand all lines: website/docs/en/api/loader-api/index.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Overview
2
2
3
-
## Compatibility Status
3
+
## Compatibility status
4
4
5
5
Rspack is committed to being compatible with the loaders within the webpack ecosystem. We ensure that Rspack is as compatible as possible with the webpack loader API, allowing more existing webpack loaders to be directly used in Rspack.
Copy file name to clipboardExpand all lines: website/docs/en/api/plugin-api/compilation-hooks.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ import Columns from '@components/Columns';
11
11
import { NoSSR } from'rspress/runtime';
12
12
import { ApiMeta } from'@components/ApiMeta';
13
13
14
-
# Compilation Hooks
14
+
# Compilation hooks
15
15
16
16
:::info
17
17
The main compilation logic of Rspack runs on the Rust side. For factors such as stability, performance, and architecture, after the Rust side compilation objects are transferred to the JavaScript side when using hooks, the modifications on these objects will not be synchronized to the Rust side. Therefore, most of hooks are "read-only".
0 commit comments