Skip to content

Commit f49e515

Browse files
committed
doc: Added guides pages
1 parent 22b0d3c commit f49e515

File tree

5 files changed

+1112
-24
lines changed

5 files changed

+1112
-24
lines changed

doc/Guide: Statuscolumn.txt

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*bars.g.-statuscolumn* Statuscolumn: A beginners guide.
1+
*bars.g-statuscolumn* Statuscolumn: A beginners guide.
22

33
▌💡 Important
44
▌ As `statuscolumn` functions mostly the same as `statusline`, I will be
@@ -57,13 +57,15 @@ You can get a functional statuscolumn quite easily using these items,
5757

5858
Let's break it down,
5959

60-
| Part | Description |
61-
| ---- | -------------------------------------------------- |
62-
| %s | The sign column. |
63-
| %C | The fold column. |
64-
| %3l | The line number. It has a width of 3 columns. |
65-
| \ | Space. |
66-
|| Border to separate the statuscolumn from the text. |
60+
╭──────┬────────────────────────────────────────────────────╮
61+
│ Part │ Description │
62+
├──────┼────────────────────────────────────────────────────┤
63+
│ %s │ The sign column. │
64+
│ %C │ The fold column. │
65+
│ %3l │ The line number. It has a width of 3 columns. │
66+
│ \ │ Space. │
67+
│ ▍ │ Border to separate the statuscolumn from the text. │
68+
╰──────┴────────────────────────────────────────────────────╯
6769

6870
------------------------------------------------------------------------------
6971
🎨 Colors
@@ -210,10 +212,10 @@ things.
210212

211213
So, we will try making some simple components such as,
212214

213-
• Line number
214-
• Fold
215-
• Signs
216-
• Separator
215+
• Line number
216+
• Fold
217+
• Signs
218+
• Separator
217219

218220
🧩 Line number ~
219221

@@ -282,7 +284,7 @@ Let's add this component to the configuration.
282284
};
283285
<
284286

285-
### 🧩 Folds
287+
🧩 Folds ~
286288

287289
https://github.com/OXY2DEV/bars.nvim/blob/images/v2/wiki/bars.statuscolumn-folds.png
288290

@@ -479,7 +481,7 @@ Let's add this component to the configuration.
479481
};
480482
<
481483

482-
### 🧩 Signs
484+
🧩 Signs ~
483485

484486
https://github.com/OXY2DEV/bars.nvim/blob/images/v2/wiki/bars.statuscolumn-signs.png
485487

@@ -509,7 +511,7 @@ We add it *before* the fold column.
509511
};
510512
<
511513

512-
### 🧩 Separator
514+
🧩 Separator ~
513515

514516
Finally, we will create a Separator between different columns.
515517

@@ -585,20 +587,20 @@ And we are done!
585587
You can check more complex components, per-window configuration, click
586588
handling etc. in the source file.
587589

588-
https://github.com/OXY2DEV/bars.nvim/blob/main/plugin/bars.lua#L37-L100
589-
Shows how to set up per-window statuscolumn.
590+
https://github.com/OXY2DEV/bars.nvim/blob/main/plugin/bars.lua#L37-L100
591+
Shows how to set up per-window statuscolumn.
590592

591-
https://github.com/OXY2DEV/bars.nvim/blob/main/lua/bars/statuscolumn.lua
592-
Shows how to manage per-window configuration, set & reset the statusline
593-
of a window and rendering statuscolumn.
593+
https://github.com/OXY2DEV/bars.nvim/blob/main/lua/bars/statuscolumn.lua
594+
Shows how to manage per-window configuration, set & reset the statusline
595+
of a window and rendering statuscolumn.
594596

595-
https://github.com/OXY2DEV/bars.nvim/blob/main/lua/bars/components/statuscolumn.lua
596-
Shows how various components are made.
597+
https://github.com/OXY2DEV/bars.nvim/blob/main/lua/bars/components/statuscolumn.lua
598+
Shows how various components are made.
597599

598600
--------------------
599601

600-
https://github.com/OXY2DEV/bars.nvim/blob/main/lua/definitions/statuscolumn.lua
601-
Shows type definitions for the statuscolumn.
602+
https://github.com/OXY2DEV/bars.nvim/blob/main/lua/definitions/statuscolumn.lua
603+
Shows type definitions for the statuscolumn.
602604

603605
--------------------
604606

0 commit comments

Comments
 (0)