Skip to content

Commit db83f2d

Browse files
committed
docs: adjust tones and phrases
1 parent 6a5dbe3 commit db83f2d

2 files changed

Lines changed: 5 additions & 7 deletions

File tree

  • docs/pages
    • en/integrations/vitepress-plugin-enhanced-readabilities
    • zh-CN/integrations/vitepress-plugin-enhanced-readabilities

docs/pages/en/integrations/vitepress-plugin-enhanced-readabilities/index.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The "**Layout Switch**" and "**Inline Highlight**" features of Enhanced Readabil
1616

1717
## Why
1818

19-
I often find myself uncomfortable reading code blocks and other wide elements in VitePress-built sites, and this discomfort is often due to the presence of code blocks and elements in the body of the text that need to be scrolled through, and even though in many ways narrower content is easier to read and scan through, the need to scroll can actually make the reading experience worse, so this plugin tries to solve this (and many more) problems from another angle.
19+
I often find myself uncomfortable reading code blocks and other wide elements in VitePress-built sites, and this discomfort is often due to the presence of code blocks and elements in the body of the text that need to be scrolled through, even though shorter content is easier to read and scan, the scrolling can worse the reading experience entirely, so this plugin tries to solve this (and many more) problems from another angle.
2020

2121
### Problems solved
2222

@@ -26,20 +26,18 @@ I often find myself uncomfortable reading code blocks and other wide elements in
2626

2727
> These are just some of the issues I can think of that I've been able to address in my long hours of learning and using the plugin, and the plugin doesn't limit itself to working on these issues. You can also open a separate Issue in [GitHub](https://github.com/nolebase/integrations) to discuss problems you think might be solved and your ideas.
2828
29-
I know that this kind of functionality can be made into a browser plugin across a wide variety of different sites, but I think VitePress is clearly a better and faster testing playground, and since Nólëbase is based on VitePress, I wanted to make this plugin as part of an integration that would make it easy for me and everyone else to integrate it directly into the VitePress project and give it a try.
29+
I know that this kind of functionality can be made into a browser plugin to cover a wide variety of different sites, but I think VitePress is clearly a better and faster testing playground, and since Nólëbase is based on VitePress, I wanted to make this plugin as part of an integration that would make it easy for me and everyone else to integrate it directly into the VitePress project and give it a try.
3030

3131
### Features included
3232

3333
1. Layout switch
3434
2. Inline highlight
3535

36-
Why don't we talk and introduce less, and let's take a look at the demo of the plugin.
37-
3836
## How to use
3937

4038
### Installation
4139

42-
I can't wait, just tell me how to get it into my project!
40+
> I can't wait, just tell me how to get it into my project!
4341
4442
You can install `@nolebase/vitepress-plugin-enhanced-readabilities` as one of your VitePress project dependencies with the following command:
4543

@@ -241,7 +239,7 @@ The Reading Enhancements plugin currently provides configuration options related
241239

242240
### Configure in VitePress
243241

244-
Since VitePress doesn't provide more functionality for the default theme to expand the theme configuration, it is not friendly to the type checking and maintenance of the configuration if we directly modify the VitePress configuration file to provide configuration for the plugin.
242+
Since VitePress doesn't provide more functionality for the default theme to extend the default theme configuration, it is not friendly to the type checking and maintenance of the configuration if we directly modify the major VitePress configuration object to provide options for the plugin.
245243

246244
Therefore we offer a way with [Vue's dependency injection](https://vuejs.org/api/composition-api-dependency-injection.html#injection) to provide options and configuration for the plugin:
247245

docs/pages/zh-CN/integrations/vitepress-plugin-enhanced-readabilities/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737

3838
### 安装
3939

40-
我等不及了,快告诉我怎么弄到我的项目里!
40+
> 我等不及了,快告诉我怎么弄到我的项目里!
4141
4242
你可以通过下面的命令将 `@nolebase/vitepress-plugin-enhanced-readabilities` 安装到你的项目依赖中:
4343

0 commit comments

Comments
 (0)