Giter VIP home page Giter VIP logo

table-to-markdown's Introduction

Issues MIT License LinkedIn Chrome Web Store Version Chrome Web Store Users


Logo

Table to Markdown

A Chrome DevTools extension to convert an HTML Table to Markdown for easy export.

Report a Bug · Request a Feature

About The Project

This Chrome DevTools extension adds an extra tab to the Chrome DevTools and will allow you to export any HTML Table in Markdown format.

Installing

The latest published version of the extension can be installed from the Chrome Web Store.

To load this extension locally for development, clone the repo to your machine. Visit the Chrome extensions page at chrome://extensions and click the Load Unpacked button. Navigate to and choose this project folder that you cloned. And voilà! The extension will now appear in your browser and DevTools.

Usage

Navigate to a page that has an HTML table element. Right click anywhere on the table you would like to export and inspect it in your DevTools. You don't have to select the top <table> element yourself! If you selected anything inside of the table, the extension will find the entire table.

Open the Table to Markdown panel of the DevTools (you may need to click the dropdown to see it). Click the Convert to Markdown button, and your markdown table will appear in the box.

HTML Table export format

To see an example of how a table will be rendered, let's look at the following table taken from the Scholastic Accolades Wikipedia page.


<tr>
  <th>Accolade</th>
  <th>Name</th>
  <th>Death
  </th>
</tr>
<tr>
  <td><i>Doctor Aristotelis Anima</i></td>
  <td><a title="Johannes Dondus">Johannes Dondus</a></td>
  <td>1380</td>
</tr>
<tr>
  <td><i>Doctor a Doctoribus</i></td>
  <td><a title="Antonius Franciscus">Antonius Franciscus</a></td>
  <td>1528</td>
</tr>
<tr>
  <td><i>Doctor Fons Canonum</i></td>
  <td><a title="Johannes Andrea">Johannes Andrea</a></td>
  <td>1348</td>
</tr>
<tr>
  <td><i>Doctor Fons Juris Utriusque</i></td>
  <td><a title="Henry of Susa">Henry of Susa</a> (Ostia)</td>
  <td>1267-81</td>
</tr>
<tr>
  <td><i>Doctor Lucerna Juris</i></td>
  <td><a title="Baldus de Ubaldis">Baldus de Ubaldis</a></td>
  <td>1400</td>
</tr>
<tr>
  <td><i>Doctor Lucerna Juris Pontificii</i></td>
  <td><a title="Nicholas Tedeschi">Nicholas Tedeschi</a> (O.S.B.)</td>
  <td>1445</td>
</tr>
<tr>
  <td><i>Doctor Lumen Juris</i></td>
  <td><a title="Pope Clement IV">Pope Clement IV</a></td>
  <td>1268
  </td>
</tr>
<tr>
  <td><i>Doctor Lumen Legum</i></td>
  <td><a title="Irnerius">Irnerius</a></td>
  <td>1125 (after)
  </td>
</tr>
<tr>
  <td><i>Doctor Memoriosissimus</i></td>
  <td><a title="Ludovicus Pontanus">Ludovicus Pontanus</a></td>
  <td>1439</td>
</tr>
<tr>
  <td><i>Doctor Monarcha Juris</i></td>
  <td><a title="Bartholomew of Saliceto">Bartholomew of Saliceto</a></td>
  <td>1412</td>
</tr>
<tr>
  <td><i>Doctor Os Aureum</i></td>
  <td><a title="Bulgarus">Bulgarus</a></td>
  <td>1166</td>
</tr>
<tr>
  <td><i>Doctor Pater Decretalium</i></td>
  <td><a title="Gregory IX">Gregory IX</a></td>
  <td>1241</td>
</tr>
<tr>
  <td><i>Doctor Pater et Organum Veritatis</i></td>
  <td><a title="Pope Innocent IV">Pope Innocent IV</a></td>
  <td>1254</td>
</tr>
<tr>
  <td><i>Doctor Pater Juris</i></td>
  <td><a title="Pope Innocent III">Pope Innocent III</a></td>
  <td>1216</td>
</tr>
<tr>
  <td><i>Doctor Pater Peritorum</i></td>
  <td><a title="Pierre de Belleperche">Pierre de Belleperche</a></td>
  <td>1307</td>
</tr>
<tr>
  <td><i>Doctor Planus ac Perspicuus</i></td>
  <td><a title="Walter Burley">Walter Burleigh</a></td>
  <td>1337</td>
</tr>
<tr>
  <td><i>Doctor Princeps Subtilitatum</i></td>
  <td><a title="Francesco d'Accolti">Francesco d'Accolti</a></td>
  <td>1486</td>
</tr>
<tr>
  <td><i>Doctor Speculator</i></td>
  <td><a title="William Durandus">William Durandus</a></td>
  <td>1296</td>
</tr>
<tr>
  <td><i>Doctor Speculum Juris</i></td>
  <td><a title="Bartholus of Sassoferrato">Bartholus of Sassoferrato</a></td>
  <td>1359</td>
</tr>
<tr>
  <td><i>Doctor Subtilis</i></td>
  <td><a title="Benedict Raymond">Benedict Raymond</a></td>
  <td>1440</td>
</tr>
<tr>
  <td><i>Doctor Subtilis</i></td>
  <td>Filippo Corneo</td>
  <td>1462</td>
</tr>
<tr>
  <td><i>Doctor Verus</i></td>
  <td><a title="Thomas Doctius">Thomas Doctius</a>, Siena</td>
  <td>1441</td>
</tr>

This table will be rendered in Markdown as follows:

|             Accolade              |            Name            |    Death     |
|-----------------------------------|----------------------------|--------------|
|     Doctor Aristotelis Anima      |      Johannes Dondus       |     1380     |
|        Doctor a Doctoribus        |    Antonius Franciscus     |     1528     |
|        Doctor Fons Canonum        |      Johannes Andrea       |     1348     |
|    Doctor Fons Juris Utriusque    |   Henry of Susa (Ostia)    |   1267-81    |
|       Doctor Lucerna Juris        |     Baldus de Ubaldis      |     1400     |
|  Doctor Lucerna Juris Pontificii  | Nicholas Tedeschi (O.S.B.) |     1445     |
|        Doctor Lumen Juris         |      Pope Clement IV       |     1268     |
|        Doctor Lumen Legum         |          Irnerius          | 1125 (after) |
|      Doctor Memoriosissimus       |     Ludovicus Pontanus     |     1439     |
|       Doctor Monarcha Juris       |  Bartholomew of Saliceto   |     1412     |
|         Doctor Os Aureum          |          Bulgarus          |     1166     |
|     Doctor Pater Decretalium      |         Gregory IX         |     1241     |
| Doctor Pater et Organum Veritatis |      Pope Innocent IV      |     1254     |
|        Doctor Pater Juris         |     Pope Innocent III      |     1216     |
|      Doctor Pater Peritorum       |   Pierre de Belleperche    |     1307     |
|    Doctor Planus ac Perspicuus    |      Walter Burleigh       |     1337     |
|   Doctor Princeps Subtilitatum    |    Francesco d'Accolti     |     1486     |
|         Doctor Speculator         |      William Durandus      |     1296     |
|       Doctor Speculum Juris       | Bartholus of Sassoferrato  |     1359     |
|          Doctor Subtilis          |      Benedict Raymond      |     1440     |
|          Doctor Subtilis          |       Filippo Corneo       |     1462     |
|           Doctor Verus            |   Thomas Doctius, Siena    |     1441     |

HTML Tables without headers

Most Markdown table parsers do not support header-less tables. To compensate for this, this extension throws in a blank header row. For example, take the following table (taken from the NBA Most Valuable Player Award Wikipedia page).


<tr>
  <td style="background-color:#CFECEC; border:1px solid #aaaaaa; width:6em; color: #535056;">^</td>
  <td>Denotes player who is still active in the NBA</td>
</tr>
<tr>
  <td style="background-color:#FFFF99; border:1px solid #aaaaaa; width:6em; color: #535056;">*</td>
  <td>Inducted into the <a title="Naismith Memorial Basketball Hall of Fame">Naismith Memorial Basketball Hall of Fame</a></td>
</tr>
<tr>
  <td style="background-color:#FFE6BD; border:1px solid #aaaaaa; width:6em; color: #535056;">†</td>
  <td>Denotes player whose team won championship that year</td>
</tr>
<tr>
  <td>Player (X)</td>
  <td>Denotes the number of times the player had been named MVP at that time</td>
</tr>
<tr>
  <td>Team (X)</td>
  <td>Denotes the number of times a player from this team had won at that time</td>
</tr>

This table will be rendered in Markdown like this:

|            |                                                                          |
|------------|--------------------------------------------------------------------------|
|     ^      |              Denotes player who is still active in the NBA               |
|     *      |       Inducted into the Naismith Memorial Basketball Hall of Fame        |
|     †      |           Denotes player whose team won championship that year           |
| Player (X) |  Denotes the number of times the player had been named MVP at that time  |
|  Team (X)  | Denotes the number of times a player from this team had won at that time |

HTML tables with missing cells

HTML tables sometimes leave off empty cells in the final column, like this table about medieval accolades.


<tr>
  <th>Accolade</th>
  <th>Name</th>
  <th>Death</th>
  <th>Translation/Notes</th>
</tr>
<tr>
  <td><i>Apostolus</i></td>
  <td>St. <atitle="Paul of Tarsus">Paul</a></td>
  <td>67</td>
  <td>Due to his preeminence among the Letters of the Apostles within the Bible</td>
</tr>
<tr>
  <td><i>Commentator</i></td>
  <td><a title="Averroes">Averroes</a> (Ibn Rushd)</td>
  <td>1198</td>
</tr>
<tr>
  <td><i>Magister sententiarum</i></td>
  <td><a title="Peter Lombard">Peter Lombard</a></td>
  <td>1160</td>
</tr>
<tr>
  <td><i>Philosophus</i></td>
  <td><a title="Aristotle">Aristotle</a></td>
  <td>BC 322</td>
</tr>
<tr>
  <td><i>Propheta</i></td>
  <td><a title="David">David</a></td>
  <td>BC 10th century</td>
  <td>Due to his authorship of the <a title="Psalms">Psalms</a></td>
</tr>
<tr>
  <td><i>Theologus</i></td>
  <td><a title="Augustine of Hippo">Augustine of Hippo</a></td>
  <td>430</td>
</tr>

It will be rendered in Markdown with the cells missing as well. Markdown parsers usually handle this gracefully and render the table with those cells blank.

|       Accolade        |         Name         |      Death      |                             Translation/Notes                             |
|-----------------------|----------------------|-----------------|---------------------------------------------------------------------------|
|       Apostolus       |       St. Paul       |       67        | Due to his preeminence among the Letters of the Apostles within the Bible |
|      Commentator      | Averroes (Ibn Rushd) |      1198       |
| Magister sententiarum |    Peter Lombard     |      1160       |
|      Philosophus      |      Aristotle       |     BC 322      |
|       Propheta        |        David         | BC 10th century |                    Due to his authorship of the Psalms                    |
|       Theologus       |  Augustine of Hippo  |       430       |

Tables with elements that span rows or columns

HTML tables allow for elements that span multiple rows or columns, a feature not supported in most Markdown flavors. To compensate for this, any cells that span multiple rows or columns are just repeated to avoid ambiguity. See this table of vowels from the Esperanto Wikipedia page.


<tr>
  <th></th>
  <th>Front</th>
  <th>Back</th>
</tr>
<tr>
  <th style="text-align: right;">Close</th>
  <td><span style="font-size:125%;">i</span></td>
  <td><span style="font-size:125%;">u</span></td>
</tr>
<tr>
  <th style="text-align: right;">Mid</th>
  <td><span style="font-size:125%;">e</span></td>
  <td><span style="font-size:125%;">o</span></td>
</tr>
<tr>
  <th style="text-align: right;">Open</th>
  <td colspan="2"><span style="font-size:125%; padding-left: 35px;">a</span></td>
</tr>

The a vowel that spans two columns at the bottom would be repeated, and the Markdown would appear as so:

|       |       |      |
|-------|-------|------|
|       | Front | Back |
| Close |   i   |  u   |
|  Mid  |   e   |  o   |
| Open  |   a   |  a   |

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch ( git checkout -b feature/AmazingFeature )
  3. Commit your Changes ( git commit -m 'Add some AmazingFeature' )
  4. Push to the Branch ( git push origin feature/AmazingFeature )
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details

Contact

Karey Higuera - @kbravh - [email protected]

Project Link: https://github.com/kbravh/table-to-markdown

table-to-markdown's People

Contributors

kbravh avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

l2l-oakfrog

table-to-markdown's Issues

Support file:/// URLs

I have trouble getting the panel to display for file:/// URLs.
When it does and I hit convert I see:

There was an issue. Please make sure that a table is selected.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.