pffy / markdown-table

Export Markdown tables from Google Sheets with this editor add-on (Cotton Markdown Tables)

markdown-table

Export Markdown tables from Google Sheets with this editor add-on

ICON

INSTALL

Google Workspace Marketplace

• Install Cotton Markdown Tables from the Google Workspace Marketplace
• https://workspace.google.com/marketplace/app/cotton_markdown_tables/734474805574
• Recommended.
  • Apps and add-ons are actively monitored and curated by Google.
  • Better add-on management (install, remove, auto-update).
  • New updates and critical fixes are available immediately.

Copy spreadsheet document

• Not available at this time.

G Suite administrator

• Ask your G Suite administrator to add Cotton Markdown Tables to an add-on whitelist.
• You can (alternatively) also ask your administrator to simply install Cotton Markdown Tables automatically.
• Preferred by organizations with Chromebook management and acceptable use policies.
• Important things to tell your administrator:
  • "Cotton Markdown Tables add-on is free and open-source."
  • "Cotton Markdown Tables add-on only provides stable features with each deployment."
  • "Thank you for keeping my Chromebook safe, secure and fully operational."
  • "Cotton Markdown Tables add-on does not phone home."
• Important things to show your administrator:
  • See PERMISSIONS section.
  • See COMPLIANCE section.

Manual install

NOTE: for developers and power users.

• Add each file in the dist folder to your Google Apps Script editor project.
  • Create each file. Copy/paste the contents of each file.
  • In the Google Apps Script Editor Project Settings tab, be sure the box that says Show "appsscript.json" manifest file in editor before you copy/paste the contents into that file.
  • You must still grant authorization to yourself to use the special permissions.

Command-line install with clasp

NOTE: for developers and power users.

• You can use clasp to work with these files from the command-line:
  • Learn more: https://developers.google.com/apps-script/guides/clasp

PERMISSIONS

In order to provide useful features, this add-on requires permissions from you. The following describes the purpose of permissions for this add-on:

Google Drive

• "See, edit, create, and delete all of your Google Drive files"
  • This permssion allows the add-on to create a Cotton Markdown Tables folder and save Markdown table documents on your Google Drive. Additionally, this feature allows the add-on to jump directly to the saved Markdown file or download the Markdown file to your desktop. No user data sent to pffy-cloud.

Google Sheets

• "View and manage spreadsheets that this application has been installed in"
  • This permssion allows the add-on to only read the content of the spreadsheet that is currently open. Reading this information helps the add-on determine how to convert betweeen spreadsheet formatting and Markdown syntaxes. No user data sent to pffy-cloud.

Script UI

• "Display and run third-party web content in prompts and sidebars inside Google applications"
  • This permssion allows the add-on to provide user interaction for better usability. HTML, CSS, JavaScript and frameworks (e.g., jQuery) are implemented in the sidebar to help the add-on copy text to your clipboard, view saved files in your Google Drive, or download saved files to your desktop. No user data sent to pffy-cloud.

OAuth scopes

• See the SCOPES section.

Remove permissions

Permissions can be removed at any time from your Google Account.

COMPATIBILITY

Hardware Support

• Apple iPad (using Safari web browser only)
• Chromebook

Software Support

Markdown Editors	Link	Supports Multi-line cells	Supports Alignments
GitHub	https://github.com	[X]	[X]
GitHub Web Editor and IDE	https://github.dev	[X]	[X]
Atom	https://atom.io/	[X]	[X]
Bear App (with Marked 2 ??)	https://bear.app	[X]	[X]
Day One Journal	https://dayoneapp.com/	[ ]	[X]
Drafts	https://getdrafts.com/	[X]	[X]
Dillinger	https://dillinger.io/	[ ]	[X]
GitLab	https://gitlab.com	[X]	[X]
Google Colaboratory Jupyter Notebook	https://colab.research.google.com/	[X]	[X]
Mado	Chrome Web Store	[X]	[X]
Minimalist Markdown Editor	Chrome Web Store	[X]	[X]
StackEdit	https://stackedit.io/	[X]	[X]
Visual Studio Code	https://vscode.dev	[X]	[X]
WordPress	https://wordpress.com/	[ ]	[X]

FEATURES

Export options

You have six options for exporting data from Google Sheets to Markdown tables:

1. Export active range: The most basic selection in a spreadsheet.
2. Export all active ranges: This allows you to multi-select seperate ranges and export all the converted tables into a single Markdown table document.
3. Export entire sheet: This method includes all the data within a sheet without user selection.
4. Export all sheets: This method exports each sheet in the spreadsheet and places them into a single document.
5. Export selected named ranges: Choose which predefined named ranges you want and save all the generated Markdown tables in a single Markdown document.
6. Export all named ranges: Combine all the named ranges in a spreadsheet into a single Markdown document.

Deliverables

After you export Markdown tables with Cotton, you have three choices for deliverables.

You can:

• Copy the Markdown text to clipboard
• View the Markdown file in Google Drive
• Download the Markdown file to your desktop

You can watch the deliverable options video on YouTube.

YOUTUBE CHANNEL

• Cotton Markdown Tables on YouTube

SCOPES

The following OAuth scopes were used for granting this add-on PERMISSIONS.

Non-sensitive scopes

https://www.googleapis.com/auth/spreadsheets.currentonly

Sensitive scopes

https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/script.container.ui

Restricted scopes

There are no restricted scopes used in this add-on.

COMPLIANCE

This section is for compliance departments within companies, agencies or organizations that must provide documentation of licensing for internal or external audit processes.

The Cotton Markdown Tables spreadsheet editor add-on is free, libre, and open source software. Printing this web page (either as paper for PDF) and retaining a copy for your records is sufficient documentation for your organization’s site license or domain license.

PRIVACY POLICY

This add-on complies with the Google API Services User Data Policy. Additionally, we are committed to exceeding these requirements while delivering wonderful user experiences, without collecting any personally-identifying information about you. These efforts are described with greater detail in our privacy policy:

• https://a.pffy.dev/about/privacy

TERMS OF SERVICE

• https://a.pffy.dev/about/terms

DISCLAIMERS

Google Sheets, Google Drive, and other Google software or features are trademarks of Google, an Alphabet company. jQuery belongs to the OpenJS Foundation and jQuery contributors. GitHub belongs to Microsoft.

LICENSE

• https://unlicense.org/

REFERENCE

• Does the name Gruber mean anything to you, lieutenant? It rings a few bells. Markdown was created by John Gruber.

markdown-table's Issues

[ feature ]: Convert <<YOUTUBE_URL>> into linked preview thumbnail image

Using the canonical YouTube watch URL:

https://www.youtube.com/watch?v=[VIDEO_ID]

Adding double brackets to each side:

<<https://www.youtube.com/watch?v=[VIDEO_ID]>>

generates a linked YouTube thumbnail during Markdown table conversion:

[![TEXT_HERE](YOUTUBE_IMAGE_URL "TEXT_HERE")](YOUTUBE_WATCH_URL)

Some punctuation affects Markdown table renderning on GitHub

When certain characters start a Markdown table sequence, GitHub attempts to render the table sequence as another HTML element. The following table provides results of a pass/fail test that placed items from an enumerated list of punctuation characters at the beginning of a Markdown table sequence.

[feature class]: features that use the Google Sheets FORMULA are locale-dependent

There is a "class of features" for add-ons that depend on spreadsheet formulas (e.g., =HYPERLINK(), =IMAGE(), etc.). The behavior of these formulas depend on spreadsheet locale (language and location).

Before we add these type of features that depend on spreadsheet cell formulas, this Markdown table add-on should be (somewhat) localized.

Localization requires a better understanding for each implemented locale. For example, functions either use a COMMA or SEMICOLON as function parameter delimiters.

Test data available here: pffy/udon#1

[ feature ]: use cell notes to add footnotes below Markdown table

add superscript reference ¹ next to Markdown table cell contents, and (in turn) list those references below the completed table in a list of footnotes

[remove]: the about box will be removed, one less thing to worry about

about.html to be removed.
references to opening the about box in ui.gs to be removed.

[ feature ]: add support for UNDERLINE font style

when the text is not hyperlinked, it is possible to underline the text

[ feature ]: add support for =IMAGE formula / function in Markdown table export from Google Sheet

support may include:

=IMAGE("https://url")

[ feature ]: add support for =HYPERLINK formula / function

support may include:

=HYPERLINK("https://url")
=HYPERLINK(A1)
=HYPERLINK("https://url" & A1)
=HYPERLINK("https://url","text")
=HYPERLINK(A1,A1)
=HYPERLINK(A1,"text" & A1)

[feature] detect checkboxes in Google Sheets and convert to check marks in Markdown tables

there is a discussion and possible solution about formatting the checkbox within the Markdown table here:

https://stackoverflow.com/a/47344640

todo-list functionality is not important right now

Add Compatibility Charts for GitHub-Flavored Markdown editors and Apple iPads

Include the product name, the product web site, as well as support for line breaks (multi-line cells) and column alignments.

Editor	Website	Supports line breaks	Supports alignments
derp	derp	[X]	[ ]
derp	derp	[X]	[X]
derp	derp	[X]	[X]

Hyperlinked number cells lose links when exported

A cell that contains only a number and has a hyperlink loses the link when exported. For example, I would expect a cell with 3.1415 linked to the Wikipedia page for pi to export as:

|Value|
|--: |
|[3.1415](https://en.wikipedia.org/wiki/Pi)|

but instead it produces

|Value|
|--: |
|3.1415|

In contrast, hyperlinked text exports correctly.

Not Google Verified

I wanted to try this out, but Google says it's not verified.

[feature] Adding multi-line support for Markdown table cells

in other words, the new line feed \n should be converted to line break <br/> HTML tag, for multi-line support for Markdown table cells

removing deprecated stuff

with the implementation of the classes TextStyle and RichTextValue the following are no longer needed:

Range.getFontWeights()
Range.getFontStyles()
Range.getFontLines()

[ update ]: refresh list of Google monospace (fixed-width) fonts for detection

Current list:

'anonymous pro',
'b612 mono',
'courier',
'courier new',
'courier prime',
'cousine',
'cutive mono',
'dm mono',
'droid sans mono',
'fira code',
'fira mono',
'ibm plex mono',
'inconsolata',
'major mono display',
'monospace',
'nanum gothic coding',
'nova mono',
'overpass mono',
'oxygen mono',
'pt mono',
'roboto mono',
'share tech mono',
'space mono',
'source code pro',
'ubuntu mono',
'vt323'