VoronDesign / Voron-Documentation

Sources of the documentation website for all Voron 3D printers
https://docs.vorondesign.com/
GNU General Public License v3.0
233 stars 187 forks source link

fix tables so GFM will render the tables properly #274

Open GadgetAngel opened 2 years ago

GadgetAngel commented 2 years ago

fix tables so GFM will render the tables properly

this file belongs in the following directory location:

In Community/Electronics/brewweasel

GFM language was not rendering the tables correctly due to syntax errors. Fixed the problem and now the tables get rendered as the author intended. Right now it is hard to read the tables as they are without this fix

Please see: https://github.com/VoronDesign/Voron-Documentation/pull/146#issuecomment-1126724790

GadgetAngel commented 2 years ago

This merge does not display properly on the LIVE website, even tho the .md file looks fine:

image

To fix the issue:

  1. remove the extra space on the header lines:

    ### Expansion M1
    
    ### Expansion M2
    
    ### Expansion M3

    should be

    
    ### Expansion M1

Expansion M2

Expansion M3


2. ensure an empty line appears between the Header line and the beginning of each table:

Expansion M1

Designation | Pin ...

Expansion M2

Designation | Pin ...

Expansion M3

Designation | Pin ...

should be

Expansion M1

Designation | Pin ...

Expansion M2

Designation | Pin ...

Expansion M3

Designation | Pin ...



I fixed it on my LIVE website https://gadgetangel.org/community/electronics/brewweasel/BTTExpansion.html and it looks like this with the above fixes:
![image](https://user-images.githubusercontent.com/33468777/168429693-6dc2e543-03cc-4baa-b598-255b24535b3e.png)