create-rspress 1.39.4 → 1.40.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-rspress",
3
- "version": "1.39.4",
3
+ "version": "1.40.0",
4
4
  "description": "Create a new Rspress project",
5
5
  "homepage": "https://rspress.dev",
6
6
  "repository": {
@@ -26,7 +26,7 @@
26
26
  "create-rstack": "1.0.9"
27
27
  },
28
28
  "devDependencies": {
29
- "@microsoft/api-extractor": "^7.48.1",
29
+ "@microsoft/api-extractor": "^7.49.1",
30
30
  "@rslib/core": "0.2.2",
31
31
  "@types/node": "^18.11.17",
32
32
  "typescript": "^5.5.3"
@@ -5,7 +5,7 @@
5
5
  "activeMatch": "/guide/"
6
6
  },
7
7
  {
8
- "text": "Hello World",
8
+ "text": "Hello world",
9
9
  "link": "/hello/",
10
10
  "activeMatch": "/hello/"
11
11
  },
@@ -7,10 +7,10 @@ Rspress supports not only Markdown but also [MDX](https://mdxjs.com/), a powerfu
7
7
  MDX is a superset of Markdown, which means you can write Markdown files as usual. For example:
8
8
 
9
9
  ```md
10
- # Hello World
10
+ # Hello world
11
11
  ```
12
12
 
13
- ## Use Component
13
+ ## Use component
14
14
 
15
15
  When you want to use React components in Markdown files, you should name your files with `.mdx` extension. For example:
16
16
 
@@ -18,18 +18,18 @@ When you want to use React components in Markdown files, you should name your fi
18
18
  // docs/index.mdx
19
19
  import { CustomComponent } from './custom';
20
20
 
21
- # Hello World
21
+ # Hello world
22
22
 
23
23
  <CustomComponent />
24
24
  ```
25
25
 
26
- ## Front Matter
26
+ ## Front matter
27
27
 
28
28
  You can add Front Matter at the beginning of your Markdown file, which is a YAML-formatted object that defines some metadata. For example:
29
29
 
30
30
  ```yaml
31
31
  ---
32
- title: Hello World
32
+ title: Hello world
33
33
  ---
34
34
  ```
35
35
 
@@ -39,7 +39,7 @@ You can also access properties defined in Front Matter in the body, for example:
39
39
 
40
40
  ```markdown
41
41
  ---
42
- title: Hello World
42
+ title: Hello world
43
43
  ---
44
44
 
45
45
  # {frontmatter.title}
@@ -48,10 +48,10 @@ title: Hello World
48
48
  The previously defined properties will be passed to the component as `frontmatter` properties. So the final output will be:
49
49
 
50
50
  ```html
51
- <h1>Hello World</h1>
51
+ <h1>Hello world</h1>
52
52
  ```
53
53
 
54
- ## Custom Container
54
+ ## Custom container
55
55
 
56
56
  You can use the `:::` syntax to create custom containers and support custom titles. For example:
57
57
 
@@ -117,9 +117,9 @@ This is a `block` of `Custom Title`
117
117
  This is a `block` of `Custom Title`
118
118
  :::
119
119
 
120
- ## Code Block
120
+ ## Code block
121
121
 
122
- ### Basic Usage
122
+ ### Basic usage
123
123
 
124
124
  You can use the \`\`\` syntax to create code blocks and support custom titles. For example:
125
125
 
@@ -145,7 +145,7 @@ console.log('Hello World');
145
145
  console.log('Hello World');
146
146
  ```
147
147
 
148
- ### Show Line Numbers
148
+ ### Show line numbers
149
149
 
150
150
  If you want to display line numbers, you can enable the `showLineNumbers` option in the config file:
151
151
 
@@ -158,7 +158,7 @@ export default {
158
158
  };
159
159
  ```
160
160
 
161
- ### Wrap Code
161
+ ### Wrap code
162
162
 
163
163
  If you want to wrap long code line by default, you can enable the `defaultWrapCode` option in the config file:
164
164
 
@@ -171,7 +171,7 @@ export default {
171
171
  };
172
172
  ```
173
173
 
174
- ### Line Highlighting
174
+ ### Line highlighting
175
175
 
176
176
  You can also apply line highlighting and code block title at the same time, for example:
177
177
 
@@ -1,4 +1,4 @@
1
- # Hello World!
1
+ # Hello world!
2
2
 
3
3
  ## Start
4
4
 
@@ -8,7 +8,7 @@
8
8
  "preview": "rspress preview"
9
9
  },
10
10
  "dependencies": {
11
- "rspress": "^1.39.3"
11
+ "rspress": "^1.39.4"
12
12
  },
13
13
  "devDependencies": {
14
14
  "@types/node": "^18.11.17"
@@ -1,4 +1,4 @@
1
- # Rspress Website
1
+ # Rspress website
2
2
 
3
3
  ## Setup
4
4
 
@@ -8,7 +8,7 @@ Install the dependencies:
8
8
  npm install
9
9
  ```
10
10
 
11
- ## Get Started
11
+ ## Get started
12
12
 
13
13
  Start the dev server:
14
14