Privacy Policy

Privacy Policy (for Google OAuth Verification)

version 2021/10/15

This document would thoroughly disclose the manner in which the GGeditor accesses, uses, stores, or shares Google user data. Here, the “Google user data” means the opening Google document which every add-ons of the Google Docs are working with.

How the GGeditor accesses Google user data:The GGeditor is an Add-on for the Google Docs App. When users installed The GGeditor add-on. It is listed on the menu bar by the Google Docs Aoo. The GGeditor works in an environment which is provided and limited by the Add-on feature of the Google Docs. The GGeditor accesses the opening Google document via the Google Docs App.

How the GGeditor uses Google user data:The GGeditor convert content of the opening Google document to reStructuredText format.

How the GGeditor stores Google user data:The GGeditor does not store any content of the opening Google document. The GGeditor only stores users settings via the Google Docs App. Which is provided by the Add-on development API.

How the GGeditor shares Google user data:The GGeditor does not share content of the opening Google document.

The converted reStructuredText content would be pushed to a repository of the Github. That repository is owned by the user, not the GGeditor. Because the repository name, path and credentials for accessing that repository are all given by the user.

Announcements - 2020

Announcements - 2017

GGeditor

IMG1 Italian version by Ciro Spataro

GGeditor hopes to help you to focus on writing your idea instead of marking them up.

GGeditor is a Google Docs Add-on for generating reStructuredText file from the Google Docs. The generated reST file can be committed to the Github repository with the GGeditor. Then, that repository’s documentations hosted by the Readthedocs.org (RTD) got automatically updated.

IMG2

Note

You don’t need to trigger conversion before committing and downloading, the committing and downloading would do conversion internally at first.

Features

  1. Easy starting for reST beginners, even no idea about reST markups.
  2. Powered by the Google Docs. Almost what you see is what you get. As well as the coordination of team works.
  3. One-click to commit to the Github repository.
  4. Preview the generated reST file and download to local machine.
  5. Support headings, bold, italic, hyperlink, subscript and superscript.
  6. Support footnotes, image, list item and table.
  7. Support full-width characters (CKJ) in headings and table.
  8. Support internal links to bookmarks, headings and Google Docs native table of contents (in document table of contents).
  9. Support relative links to other generated reST files of the Google Docs under the same folder and subfolders.
  10. Support cross-document table of content (.. toctree::) for the RTD.
  11. Support all style of admonitions of the RTD.
  12. Support multiple accounts for committing to repositories in different accounts.
  13. Support converting table with HTML tags to let look-and-feel as the same as possible for blogers.

How to install

Click this link to the Google Docs Add-on page, or in a Google Docs Document:

  1. On the menu item “Add-ons”, click the “Get Add-ons”
  2. In the search box, input “GGeditor”, then click on the GGeditor icon to install.

IMG3

How to Use

Please refer to this article How to Use

For reStructuredText Beginners

If you are a beginner of the reStructuredText and you feel a little bit of confusing about how to put your documents onto the RTD website. I wrote two quick guides to help your task to be quickly completed with the GGeditor.

How to create a generic website of documentation on the RTD

This guide for you to make the 1st copy of your product documents get online.

How to create API document for python modules

This guide for you to make the 1st copy of your module documents get online.

I was struggling on writing reStructuredText for a long time . Now, with the GGeditor and these two tutorials, I hope them can help you to get jobs done quicker and easier.

Acknowledgments

Release Notes

Jan 15, 2017

New:

  1. Convert table in HTML tags for preserving background color, column-span, row-span and column width.
  2. Multiple github accounts

Improved:

  1. New “Settings” panel for accounts and document options.
  2. In partial conversion, markups of table will keep the same as it is in whole document conversion.

Dec 27, 2016

Improved:

  • Create new file in github failed if the new path has new folder great than 1 level, ex, create docs/blog/technical/how2pythondocs.py in docs/ where blog/technical is not existed yet.
  • For In-document TOC, there is no extra empty line between items.
  • For partial convsion of selection or table, the conversion dialog would break a line for every 60 characters. It makes content easier to read.
  • For simplicity, the “Download” button is hidden in partial conversion except images are included.
  • Hyperlink in footnote content is allowed.
  • “Add link to another document” only displays items binding to the same repository with current document. And generated path is relative to current document.

Fixed:

  • Insert link to another document failed for documents with binding file if the binding path is different document path.

Featured:

  • Add directive of “custom admonition”.
  • Add directive of “raw HTML”

Limited:

  • Internal link to heading does not work. Currently there is no API to identifiy the target heading element. Please use “Bookmark“ instead.

Dec 6, 2016

New

  • Support partial conversion for selectd elements and table.
  • Same image used multiple times is now only one copy been uploaded.

Improved

  • Conversion features has an individual dialog. (improvment)

Fixed

  • Downloaded zip file now got file name from binding file. (bug fix)

Appreciation for You

It would really help us if you had a second to

that helps us keep momentun on GGeditor.

Source document in the Google Docs