Skip to content

Latest commit

 

History

History
206 lines (136 loc) · 9.23 KB

README.md

File metadata and controls

206 lines (136 loc) · 9.23 KB

markdown-table

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

ICON

icon120

INSTALL

Google Workspace Marketplace

Google Workspace Marketplace badge

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:

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.

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

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.

cotton_menu

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.

cotton_prompt

YOUTUBE CHANNEL

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:

TERMS OF SERVICE

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

REFERENCE

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