[jira] [Updated] (AURORA-234) Consider using markdown-style tables instead of HTML

["Dan Norris (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/AURORA-234?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Dan Norris updated AURORA-234:
------------------------------

    Attachment: original.png
                markdown.png

Here's a comparison between the rendered Markdown and the HTML tables that are currently in the docs.

Some of the formatting in the Markdown is a little off, but overall it looks fine without the table borders. As far as I can tell there's no way to add them back in easily using Redcarpet and Middleman without writing some sort of plugin or custom CSS.

> Consider using markdown-style tables instead of HTML
> ----------------------------------------------------
>
>                 Key: AURORA-234
>                 URL: https://issues.apache.org/jira/browse/AURORA-234
>             Project: Aurora
>          Issue Type: Task
>          Components: Documentation
>            Reporter: Bill Farner
>            Priority: Minor
>              Labels: newbie
>         Attachments: markdown.png, original.png
>
>
> Here's a useful gist with an example of the syntax: https://gist.github.com/jkschoen/5389209
> It would be nice for docs to be more readable in a plain-text editor; and replacing the HTML-defined tables would be a big step forward.



--
This message was sent by Atlassian JIRA
(v6.2#6252)