search

jakartaee / jekyll-theme-jakarta-ee

This theme is currently experimental, but intended to provide the branding for Jakarta EE projects using GitHub pages for their documentation.
https://jakartaee.github.io/jekyll-theme-jakarta-ee/
Eclipse Public License 2.0
4 stars 14 forks source link

Remove assets/css/styles.css #2

Open chrisguindon opened 5 years ago

chrisguindon commented 5 years ago

I am wondering if we should remove https://github.com/jakartaee/jekyll-theme-jakarta-ee/blob/master/assets/css/styles.css from this theme and leverage Bootstrap tables styles (https://getbootstrap.com/docs/3.3/css/#tables ) to keep a consistent L&F for tables between jakarta.ee and project websites.

I believe that the problem that we are solving with assets/css/styles.css is:

Projects won't be required to add {: class=table} or {.table} to the markdown tables. I really don't like this solution since we should try to keep the markdown files as pure as possible.

We might be able to solve this problem by creating a custom parser via kramdown api but this might not be possible with github pages.

Another solution would be to automatically add .table class with Javascript/jQuery which I think is a good compromise:

$("main table").addClass("table");

jgallimore commented 5 years ago

The selectors are table, th and td so these should be applied to any <table> without requiring a specific class to be added to the table.

If you take a look at the tables on this page: https://jgallimore.github.io/javamail/ you'll see the border and slight padding added by this CSS. This table doesn't have a .table CSS class. The tables definitely don't render well without these couple of styles.

I'm ok to apply the styles using Javascript/jQuery if that is more consistent with other jakarta.ee sites.