Skip to content

Commit 44e9d8c

Browse files
authored
Update README.md
1 parent 254a15b commit 44e9d8c

1 file changed

Lines changed: 15 additions & 13 deletions

File tree

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ To highlight lines specify `hl:` followed by line numbers in the first line of t
8181
- You can specify ranges e.g.: `hl:2-5` This would highlight lines from 2 to 5.
8282
- You can also combine the methods e.g.: `hl:1,3,4-6` This would highlight lines 1, 3 and lines from 4 to 6.
8383

84-
Example:
84+
Example:
8585
` ```cpp hl:1,3,4-6`
8686

8787
![Pasted_image_20230125230046.png](attachments/Pasted_image_20230125230046.png)
@@ -113,7 +113,7 @@ It is possible now to highlight text instead of lines. To use this option you ha
113113
114114
An example code block with text highlight, using three different colors is shown below:
115115

116-
![[Pasted_image_20240227234145.png]]
116+
![[Pasted_image_20240227234145.png]](attachments/Pasted_image_20240227234145.png)
117117

118118
## Language specific coloring
119119

@@ -132,7 +132,7 @@ First, you have to add a language. Then you can select which color you want to s
132132

133133
An example is shown below, where the background color has been defined for "Python", "JavaScript" and "C++" languages.
134134

135-
![[Pasted_image_20240228002357.png]]
135+
![[Pasted_image_20240228002357.png]](attachments/Pasted_image_20240228002357.png)
136136

137137
## Border colors
138138

@@ -146,10 +146,10 @@ You can define colors for languages. This means, that if you want to show a bord
146146

147147
To display a filename specify `file:` or `title:` followed by a filename in the first line of the code block. If the filename contains space, specify it between `""` e.g.: `file:"long filename.cpp"`. `title` is basically an alias for file. If both are defined, then `file` will be used
148148

149-
Example:
150-
` ```cpp file:test.cpp`
151-
` ```cpp title:test.py`
152-
` ```cpp file:"long filename.cpp"`
149+
Example:
150+
` ```cpp file:test.cpp`
151+
` ```cpp title:test.py`
152+
` ```cpp file:"long filename.cpp"`
153153

154154
![Pasted_image_20230125230351.png](attachments/Pasted_image_20230125230351.png)
155155

@@ -159,14 +159,15 @@ Example:
159159

160160
To specify an initial fold state when the document is opened, specify `fold` in the first line of the code block. If `fold` is defined in a code block, then when you open the document, the code block will be automatically collapsed, and only the header will be displayed. You can unfold the code block by clicking on the header.
161161

162-
Example:
162+
Example:
163163
` ```cpp fold`
164164

165165
![Pasted_image_20230125230928.png](attachments/Pasted_image_20230125230928.png)
166166
### Semi-fold
167167

168168
You can enable semi-folding in settings tab:
169169
![Pasted_image_20230831132418.png](attachments/Pasted_image_20230831132418.png)
170+
170171
After enabling it, you have to select the count of the visible lines (default is 5). Optionally you can also enable an additional uncollapse button, which will be displayed in the last line.
171172
Semi-fold works just like the normal fold with the following differences:
172173
- If your code block doesn't have minimum required lines, then it will fold as until now.
@@ -178,13 +179,13 @@ Example: You set the count of visible lines to 5, and you have a code block with
178179
>[!note]
179180
>There is a slight difference between editing mode and reading mode. In editing mode the first line of the code block (where you define the language and the parameters) also counts, in reading mode not, since it doesn't exist. This will probably change in the next release so it is the same between editing and reading mode.
180181
181-
Example semi-folded code block (light theme):
182+
Example semi-folded code block (light theme):
182183
![Pasted_image_20230831134504.png](attachments/Pasted_image_20230831134504.png)
183184

184-
Example semi-folded code block (dark theme):
185+
Example semi-folded code block (dark theme):
185186
![Pasted_image_20230831134431.png](attachments/Pasted_image_20230831134431.png)
186187

187-
Example semi-folded code block with additional uncollapse button:
188+
Example semi-folded code block with additional uncollapse button:
188189
![Pasted_image_20230831134601.png](attachments/Pasted_image_20230831134601.png)
189190

190191

@@ -279,10 +280,11 @@ By default the links, which point to another document in your vault, are not upd
279280
280281
Sample code block with links, but with the option `Enable links usage` disabled:
281282

282-
![[Pasted_image_20240228005151.png]]
283+
![[Pasted_image_20240228005151.png]](attachments/Pasted_image_20240228005151.png)
284+
283285
Same code block with the `Enable links usage` option enabled:
284286

285-
![[Pasted_image_20240228005240.png]]
287+
![[Pasted_image_20240228005240.png]](attachments/Pasted_image_20240228005240.png)
286288

287289
## How to install the plugin
288290

0 commit comments

Comments
 (0)