Skip to content

Commit d8be437

Browse files
MeanderingProgrammerMeanderingProgrammer
committed
chore: update readme hide configs
1 parent b456d53 commit d8be437

File tree

2 files changed

+90
-2
lines changed

2 files changed

+90
-2
lines changed

‎README.md‎

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Some of the more useful fields are discussed further down.
119119

120120
<details>
121121

122-
<summary>Full Default Configuration</summary>
122+
<summary>Default Configuration</summary>
123123

124124
```lua
125125
require('render-markdown').setup({
@@ -590,6 +590,10 @@ We use the following definitions when discussing indexing into arrays:
590590

591591
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Headings)
592592

593+
<details>
594+
595+
<summary>Heading Configuration</summary>
596+
593597
```lua
594598
require('render-markdown').setup({
595599
heading = {
@@ -658,10 +662,16 @@ require('render-markdown').setup({
658662
})
659663
```
660664

665+
</details>
666+
661667
## Code Blocks
662668

663669
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/CodeBlocks)
664670

671+
<details>
672+
673+
<summary>Code Block Configuration</summary>
674+
665675
```lua
666676
require('render-markdown').setup({
667677
code = {
@@ -717,10 +727,16 @@ require('render-markdown').setup({
717727
})
718728
```
719729

730+
</details>
731+
720732
## Dashed Line
721733

722734
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/DashedLine)
723735

736+
<details>
737+
738+
<summary>Dashed Line Configuration</summary>
739+
724740
```lua
725741
require('render-markdown').setup({
726742
dash = {
@@ -739,10 +755,16 @@ require('render-markdown').setup({
739755
})
740756
```
741757

758+
</details>
759+
742760
## List Bullets
743761

744762
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/ListBullets)
745763

764+
<details>
765+
766+
<summary>Bullet Point Configuration</summary>
767+
746768
```lua
747769
require('render-markdown').setup({
748770
bullet = {
@@ -763,10 +785,16 @@ require('render-markdown').setup({
763785
})
764786
```
765787

788+
</details>
789+
766790
## Checkboxes
767791

768792
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Checkboxes)
769793

794+
<details>
795+
796+
<summary>Checkbox Configuration</summary>
797+
770798
```lua
771799
require('render-markdown').setup({
772800
-- Checkboxes are a special instance of a 'list_item' that start with a 'shortcut_link'
@@ -804,10 +832,16 @@ require('render-markdown').setup({
804832
})
805833
```
806834

835+
</details>
836+
807837
## Block Quotes
808838

809839
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/BlockQuotes)
810840

841+
<details>
842+
843+
<summary>Block Quote Configuration</summary>
844+
811845
```lua
812846
require('render-markdown').setup({
813847
quote = {
@@ -827,10 +861,16 @@ require('render-markdown').setup({
827861
})
828862
```
829863

864+
</details>
865+
830866
## Tables
831867

832868
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Tables)
833869

870+
<details>
871+
872+
<summary>Table Configuration</summary>
873+
834874
```lua
835875
require('render-markdown').setup({
836876
pipe_table = {
@@ -876,10 +916,16 @@ require('render-markdown').setup({
876916
})
877917
```
878918

919+
</details>
920+
879921
## Callouts
880922

881923
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Callouts)
882924

925+
<details>
926+
927+
<summary>Callout Configuration</summary>
928+
883929
```lua
884930
require('render-markdown').setup({
885931
-- Callouts are a special instance of a 'block_quote' that start with a 'shortcut_link'
@@ -921,10 +967,16 @@ require('render-markdown').setup({
921967
})
922968
```
923969

970+
</details>
971+
924972
## Links
925973

926974
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Links)
927975

976+
<details>
977+
978+
<summary>Link Configuration</summary>
979+
928980
```lua
929981
require('render-markdown').setup({
930982
link = {
@@ -952,10 +1004,16 @@ require('render-markdown').setup({
9521004
})
9531005
```
9541006

1007+
</details>
1008+
9551009
## Signs
9561010

9571011
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Signs)
9581012

1013+
<details>
1014+
1015+
<summary>Sign Configuration</summary>
1016+
9591017
```lua
9601018
require('render-markdown').setup({
9611019
sign = {
@@ -967,10 +1025,16 @@ require('render-markdown').setup({
9671025
})
9681026
```
9691027

1028+
</details>
1029+
9701030
## Indent
9711031

9721032
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Indent)
9731033

1034+
<details>
1035+
1036+
<summary>Indent Configuration</summary>
1037+
9741038
```lua
9751039
require('render-markdown').setup({
9761040
-- Mimic org-indent-mode behavior by indenting everything under a heading based on the
@@ -989,6 +1053,8 @@ require('render-markdown').setup({
9891053
})
9901054
```
9911055

1056+
</details>
1057+
9921058
# Colors
9931059

9941060
The table below shows all the highlight groups with their default link

‎doc/render-markdown.txt‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ sense.
165165

166166
Some of the more useful fields are discussed further down.
167167

168-
Full Default Configuration ~
168+
Default Configuration ~
169169

170170
>lua
171171
require('render-markdown').setup({
@@ -636,6 +636,8 @@ HEADINGS *render-markdown-setup-headings*
636636
Wiki Page
637637
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Headings>
638638

639+
Heading Configuration ~
640+
639641
>lua
640642
require('render-markdown').setup({
641643
heading = {
@@ -710,6 +712,8 @@ CODE BLOCKS *render-markdown-setup-code-blocks*
710712
Wiki Page
711713
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/CodeBlocks>
712714

715+
Code Block Configuration ~
716+
713717
>lua
714718
require('render-markdown').setup({
715719
code = {
@@ -771,6 +775,8 @@ DASHED LINE *render-markdown-setup-dashed-line*
771775
Wiki Page
772776
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/DashedLine>
773777

778+
Dashed Line Configuration ~
779+
774780
>lua
775781
require('render-markdown').setup({
776782
dash = {
@@ -795,6 +801,8 @@ LIST BULLETS *render-markdown-setup-list-bullets*
795801
Wiki Page
796802
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/ListBullets>
797803

804+
Bullet Point Configuration ~
805+
798806
>lua
799807
require('render-markdown').setup({
800808
bullet = {
@@ -821,6 +829,8 @@ CHECKBOXES *render-markdown-setup-checkboxes*
821829
Wiki Page
822830
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Checkboxes>
823831

832+
Checkbox Configuration ~
833+
824834
>lua
825835
require('render-markdown').setup({
826836
-- Checkboxes are a special instance of a 'list_item' that start with a 'shortcut_link'
@@ -864,6 +874,8 @@ BLOCK QUOTES *render-markdown-setup-block-quotes*
864874
Wiki Page
865875
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/BlockQuotes>
866876

877+
Block Quote Configuration ~
878+
867879
>lua
868880
require('render-markdown').setup({
869881
quote = {
@@ -889,6 +901,8 @@ TABLES *render-markdown-setup-tables*
889901
Wiki Page
890902
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Tables>
891903

904+
Table Configuration ~
905+
892906
>lua
893907
require('render-markdown').setup({
894908
pipe_table = {
@@ -940,6 +954,8 @@ CALLOUTS *render-markdown-setup-callouts*
940954
Wiki Page
941955
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Callouts>
942956

957+
Callout Configuration ~
958+
943959
>lua
944960
require('render-markdown').setup({
945961
-- Callouts are a special instance of a 'block_quote' that start with a 'shortcut_link'
@@ -987,6 +1003,8 @@ LINKS *render-markdown-setup-links*
9871003
Wiki Page
9881004
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Links>
9891005

1006+
Link Configuration ~
1007+
9901008
>lua
9911009
require('render-markdown').setup({
9921010
link = {
@@ -1020,6 +1038,8 @@ SIGNS *render-markdown-setup-signs*
10201038
Wiki Page
10211039
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Signs>
10221040

1041+
Sign Configuration ~
1042+
10231043
>lua
10241044
require('render-markdown').setup({
10251045
sign = {
@@ -1037,6 +1057,8 @@ INDENT *render-markdown-setup-indent*
10371057
Wiki Page
10381058
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Indent>
10391059

1060+
Indent Configuration ~
1061+
10401062
>lua
10411063
require('render-markdown').setup({
10421064
-- Mimic org-indent-mode behavior by indenting everything under a heading based on the

0 commit comments

Comments
 (0)