Skip to content

Support for table markdown syntax #1453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
chalin opened this issue Jun 2, 2017 · 5 comments
Closed

Support for table markdown syntax #1453

chalin opened this issue Jun 2, 2017 · 5 comments
Labels
customer-flutter Issues originating from important to Flutter customer-google3 Issues originating from or important to Angular P1 A high priority bug; for example, a single project is unusable or has many test failures type-enhancement A request for a change that isn't a bug

Comments

@chalin
Copy link
Contributor

chalin commented Jun 2, 2017

Some API pages like the one for DatePipe contain embedded tables, which displays nicely on the TS-side of the docs. Can we get support for tables in Dart API docs too?

This is the table from the DatePipe API page:

| Component | Symbol | Short Form   | Long Form         | Numeric   | 2-digit   |
|-----------|:------:|--------------|-------------------|-----------|-----------|
| era       |   G    | G (AD)       | GGGG (Anno Domini)| -         | -         |
| year      |   y    | -            | -                 | y (2015)  | yy (15)   |
| month     |   M    | MMM (Sep)    | MMMM (September)  | M (9)     | MM (09)   |
| day       |   d    | -            | -                 | d (3)     | dd (03)   |
| weekday   |   E    | EEE (Sun)    | EEEE (Sunday)     | -         | -         |
| hour      |   j    | -            | -                 | j (13)    | jj (13)   |
| hour12    |   h    | -            | -                 | h (1 PM)  | hh (01 PM)|
| hour24    |   H    | -            | -                 | H (13)    | HH (13)   |
| minute    |   m    | -            | -                 | m (5)     | mm (05)   |
| second    |   s    | -            | -                 | s (9)     | ss (09)   |
| timezone  |   z    | -            | z (Pacific Standard Time)| -  | -         |
| timezone  |   Z    | Z (GMT-8:00) | -                 | -         | -         |

which, in GFM is rendered quite nicely as:

Component Symbol Short Form Long Form Numeric 2-digit
era G G (AD) GGGG (Anno Domini) - -
year y - - y (2015) yy (15)
month M MMM (Sep) MMMM (September) M (9) MM (09)
day d - - d (3) dd (03)
weekday E EEE (Sun) EEEE (Sunday) - -
hour j - - j (13) jj (13)
hour12 h - - h (1 PM) hh (01 PM)
hour24 H - - H (13) HH (13)
minute m - - m (5) mm (05)
second s - - s (9) ss (09)
timezone z - z (Pacific Standard Time) - -
timezone Z Z (GMT-8:00) - - -

cc @kwalrath

@kwalrath
Copy link
Contributor

kwalrath commented Jun 2, 2017

Yes, please.

@kwalrath kwalrath added type-enhancement A request for a change that isn't a bug customer-google3 Issues originating from or important to Angular labels Jun 2, 2017
@jcollins-g jcollins-g added the P2 A bug or feature request we're likely to work on label Jun 2, 2017
@jcollins-g
Copy link
Contributor

jcollins-g commented Jun 2, 2017

If this is an issue on a large number of pages (or if you're perceiving people are frequently avoiding creating tables because of this bug), elevate to P1.

@srawlins
Copy link
Member

The Dart Markdown package supports GFM tables.

@mit-mit
Copy link
Member

mit-mit commented Nov 20, 2017

We are also seeing this for Flutter packages. e.g. https://www.dartdocs.org/documentation/url_launcher/latest/

@jcollins-g @devoncarew I suggest we raise this to P1. WDYT?

@jcollins-g jcollins-g added customer-flutter Issues originating from important to Flutter P1 A high priority bug; for example, a single project is unusable or has many test failures and removed P2 A bug or feature request we're likely to work on labels Nov 20, 2017
@jcollins-g
Copy link
Contributor

Raised to P1 as while this is a not-common problem/feature request, it seems to be high impact.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-flutter Issues originating from important to Flutter customer-google3 Issues originating from or important to Angular P1 A high priority bug; for example, a single project is unusable or has many test failures type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

5 participants