Skip to main content

Added Documentation for Markdown and Ascii

· 2 min read
Alan Richardson

We now have documentation for Markdown and Ascii Tables

Added Markdown Documentation

I'm starting to add more documentation to the tool.

I've now documented the options for Markdown output with some additional information as to what Markdown is

I personally use Markdown for everything.

I write my daily logs in Markdown, all my recent books have been written in Markdown.

I primarily use pandoc to convert long form Markdown files into PDF and that works very well for me.

To preview markdown when I want to view it I either use the preview pane in Visual Studio Code although other plugins are available.

When I want to review the content that I've written, I'll typically use and if you want to preview the tables that you create in then I recommend copy and pasting the Markdown generated here into the MarkdownLivePreview text pane. It handles tables very well and formats them nicely by default.

MarkdownLivePreview also works well with the options to embolden or italicize headers and columns.

Added Ascii Table Documentation

I grew up in the age of text files so I'm used to seeing Ascii Tables to represent tabular formatted data.


| Country | Population | World Share |
| China | 1,439,323,776 | 18.47 % |
| India | 1,380,004,385 | 17.70 % |
| United States | 331,002,651 | 4.25 % |

The Ascii conversion used in is provided by the open-source Ascii Table 3 library.

I chose this because of the numerous out of the box styles which I could use as styling options for the Ascii Table conversion.

I had to make a few tweaks to the library code to get it working in the browser but I haven't expanded or changed any of the styles yet.