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: docs/pages/en/integrations/vitepress-plugin-enhanced-readabilities/index.md
+4-6Lines changed: 4 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ The "**Layout Switch**" and "**Inline Highlight**" features of Enhanced Readabil
16
16
17
17
## Why
18
18
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.
20
20
21
21
### Problems solved
22
22
@@ -26,20 +26,18 @@ I often find myself uncomfortable reading code blocks and other wide elements in
26
26
27
27
> 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.
28
28
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.
30
30
31
31
### Features included
32
32
33
33
1. Layout switch
34
34
2. Inline highlight
35
35
36
-
Why don't we talk and introduce less, and let's take a look at the demo of the plugin.
37
-
38
36
## How to use
39
37
40
38
### Installation
41
39
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!
43
41
44
42
You can install `@nolebase/vitepress-plugin-enhanced-readabilities` as one of your VitePress project dependencies with the following command:
45
43
@@ -241,7 +239,7 @@ The Reading Enhancements plugin currently provides configuration options related
241
239
242
240
### Configure in VitePress
243
241
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.
245
243
246
244
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:
0 commit comments