Skip to content

Commit 881b519

Browse files
Add links to completed wiki for examples
1 parent 25bfaf0 commit 881b519

File tree

2 files changed

+58
-1
lines changed

2 files changed

+58
-1
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,9 @@ use({
129129

130130
# Setup
131131

132+
Checkout the [Wiki](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki)
133+
for examples and images associated with different configuration options.
134+
132135
The full default configuration is provided below for reference.
133136

134137
Any part of it can be modified however for many fields this does not make much sense.
@@ -518,6 +521,8 @@ We use the following definitions when discussing indexing into arrays:
518521

519522
## Headings
520523

524+
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Headings)
525+
521526
```lua
522527
require('render-markdown').setup({
523528
heading = {
@@ -580,6 +585,8 @@ require('render-markdown').setup({
580585

581586
## Code Blocks
582587

588+
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/CodeBlocks)
589+
583590
```lua
584591
require('render-markdown').setup({
585592
code = {
@@ -628,6 +635,8 @@ require('render-markdown').setup({
628635

629636
## Dashed Line
630637

638+
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/DashedLine)
639+
631640
```lua
632641
require('render-markdown').setup({
633642
dash = {
@@ -648,6 +657,8 @@ require('render-markdown').setup({
648657

649658
## List Bullets
650659

660+
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/ListBullets)
661+
651662
```lua
652663
require('render-markdown').setup({
653664
bullet = {
@@ -670,6 +681,8 @@ require('render-markdown').setup({
670681

671682
## Checkboxes
672683

684+
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Checkboxes)
685+
673686
```lua
674687
require('render-markdown').setup({
675688
-- Checkboxes are a special instance of a 'list_item' that start with a 'shortcut_link'
@@ -705,6 +718,8 @@ require('render-markdown').setup({
705718

706719
## Block Quotes
707720

721+
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/BlockQuotes)
722+
708723
```lua
709724
require('render-markdown').setup({
710725
quote = {
@@ -726,6 +741,8 @@ require('render-markdown').setup({
726741

727742
## Tables
728743

744+
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Tables)
745+
729746
```lua
730747
require('render-markdown').setup({
731748
pipe_table = {
@@ -764,6 +781,8 @@ require('render-markdown').setup({
764781

765782
## Callouts
766783

784+
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Callouts)
785+
767786
```lua
768787
require('render-markdown').setup({
769788
-- Callouts are a special instance of a 'block_quote' that start with a 'shortcut_link'
@@ -794,6 +813,8 @@ require('render-markdown').setup({
794813

795814
## Links
796815

816+
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Links)
817+
797818
```lua
798819
require('render-markdown').setup({
799820
link = {
@@ -821,6 +842,8 @@ require('render-markdown').setup({
821842

822843
## Signs
823844

845+
[Wiki Page](https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Signs)
846+
824847
```lua
825848
require('render-markdown').setup({
826849
sign = {

doc/render-markdown.txt

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*render-markdown.txt* For 0.10.0 Last change: 2024 August 07
1+
*render-markdown.txt* For 0.10.0 Last change: 2024 August 08
22

33
==============================================================================
44
Table of Contents *render-markdown-table-of-contents*
@@ -158,6 +158,10 @@ PACKER.NVIM *render-markdown-install-packer.nvim*
158158
==============================================================================
159159
6. Setup *render-markdown-setup*
160160

161+
Checkout the Wiki
162+
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki> for
163+
examples and images associated with different configuration options.
164+
161165
The full default configuration is provided below for reference.
162166

163167
Any part of it can be modified however for many fields this does not make much
@@ -545,6 +549,9 @@ Example: `{ 1, 2, 3 }` @ 4 = 3.
545549

546550
HEADINGS *render-markdown-setup-headings*
547551

552+
Wiki Page
553+
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Headings>
554+
548555
>lua
549556
require('render-markdown').setup({
550557
heading = {
@@ -608,6 +615,9 @@ HEADINGS *render-markdown-setup-headings*
608615

609616
CODE BLOCKS *render-markdown-setup-code-blocks*
610617

618+
Wiki Page
619+
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/CodeBlocks>
620+
611621
>lua
612622
require('render-markdown').setup({
613623
code = {
@@ -657,6 +667,9 @@ CODE BLOCKS *render-markdown-setup-code-blocks*
657667

658668
DASHED LINE *render-markdown-setup-dashed-line*
659669

670+
Wiki Page
671+
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/DashedLine>
672+
660673
>lua
661674
require('render-markdown').setup({
662675
dash = {
@@ -678,6 +691,9 @@ DASHED LINE *render-markdown-setup-dashed-line*
678691

679692
LIST BULLETS *render-markdown-setup-list-bullets*
680693

694+
Wiki Page
695+
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/ListBullets>
696+
681697
>lua
682698
require('render-markdown').setup({
683699
bullet = {
@@ -701,6 +717,9 @@ LIST BULLETS *render-markdown-setup-list-bullets*
701717

702718
CHECKBOXES *render-markdown-setup-checkboxes*
703719

720+
Wiki Page
721+
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Checkboxes>
722+
704723
>lua
705724
require('render-markdown').setup({
706725
-- Checkboxes are a special instance of a 'list_item' that start with a 'shortcut_link'
@@ -737,6 +756,9 @@ CHECKBOXES *render-markdown-setup-checkboxes*
737756

738757
BLOCK QUOTES *render-markdown-setup-block-quotes*
739758

759+
Wiki Page
760+
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/BlockQuotes>
761+
740762
>lua
741763
require('render-markdown').setup({
742764
quote = {
@@ -759,6 +781,9 @@ BLOCK QUOTES *render-markdown-setup-block-quotes*
759781

760782
TABLES *render-markdown-setup-tables*
761783

784+
Wiki Page
785+
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Tables>
786+
762787
>lua
763788
require('render-markdown').setup({
764789
pipe_table = {
@@ -798,6 +823,9 @@ TABLES *render-markdown-setup-tables*
798823

799824
CALLOUTS *render-markdown-setup-callouts*
800825

826+
Wiki Page
827+
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Callouts>
828+
801829
>lua
802830
require('render-markdown').setup({
803831
-- Callouts are a special instance of a 'block_quote' that start with a 'shortcut_link'
@@ -829,6 +857,9 @@ CALLOUTS *render-markdown-setup-callouts*
829857

830858
LINKS *render-markdown-setup-links*
831859

860+
Wiki Page
861+
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Links>
862+
832863
>lua
833864
require('render-markdown').setup({
834865
link = {
@@ -857,6 +888,9 @@ LINKS *render-markdown-setup-links*
857888

858889
SIGNS *render-markdown-setup-signs*
859890

891+
Wiki Page
892+
<https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Signs>
893+
860894
>lua
861895
require('render-markdown').setup({
862896
sign = {

0 commit comments

Comments
 (0)