├── LICENSE ├── README.md └── converttomarkdown.gapps /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | gdocs2md 2 | ======== 3 | 4 | A simple Google Apps script to convert a properly formatted Google Drive Document to the markdown (.md) format. 5 | 6 | ## Usage 7 | 8 | * Adding this script to your doc (once per doc): 9 | * Open your Google Drive document (http://drive.google.com) 10 | * Tools -> Script Manager > New 11 | * Select "Blank Project", then paste this code in and save. 12 | * Clear the myFunction() default empty function and paste the contents of [converttomarkdown.gapps](https://raw.github.com/mangini/gdocs2md/master/converttomarkdown.gapps) into the code editor 13 | * File -> Save 14 | 15 | * Running the script (run as many times as you want): 16 | - Tools > Script Manager 17 | - Select "ConvertToMarkdown" function. 18 | - Click Run button (First run will require you to authorize it. Authorize and run again) 19 | - Converted doc with images attached will be emailed to you. Subject will be "[MARKDOWN_MAKER]...". 20 | 21 | 22 | ## Interpreted formats 23 | * Text: 24 | * paragraphs are separated by two newlines 25 | * text styled as heading 1, 2, 3, etc is converted to Markdown heading: #, ##, ###, etc 26 | * text formatted with Courier New is backquoted: ``text`` 27 | * links are converted to MD format: `[anchortext](url)` 28 | * Lists: 29 | * Numbered lists are converted correctly, including nested lists 30 | * bullet lists are converted to "`*`" Markdown format appropriately, including nested lists 31 | * Images: 32 | * images are correctly extracted and sent as attachments 33 | * Blocks: 34 | * Table of contents is replaced by `[[TOC]]` 35 | * blocks of text delimited by "--- class whateverclassnameyouwant" and "---" are converted to `
` 36 | * Source code: 37 | * **UPDATED**: blocks of text delimited by "--- source code" or "--- src" and "---" are converted to `
`
38 |       * **NEW**: blocks of text delimited by "--- source pretty" or "--- srcp" and "---" are converted to `
`
39 |     * Tables:
40 |       * **NEW**: Simple `` processing
41 |   * "--- jsperf ``" is replaced by an iframe that shows an interactive chart of a JSPerf test. The `` is the last part of the URL of the Browserscope anchor in your JSPerf test. Something like `"agt1YS1wcm9maWxlcnINCxIEVGVzdBjlm_EQDA"` in the URL `http://www.browserscope.org/user/tests/table/agt1YS1wcm9maWxlcnINCxIEVGVzdBjlm_EQDA`
42 |  
43 | 
44 | 
45 | ## CONTRIBUTORS
46 | 
47 | * Renato Mangini - [G+](//google.com/+renatomangini) - [Github](//github.com/mangini)
48 | * Ed Bacher - [G+](//plus.google.com/106923847899206957842) - [Github](//github.com/evbacher)
49 | 
50 | ## LICENSE
51 | 
52 | Use this script at your will, on any document you want and for any purpose, commercial or not. 
53 | The MarkDown files generated by this script are not considered derivative work and 
54 | don't require any attribution to the owners of this script. 
55 | 
56 | If you want to modify and redistribute the script (not the converted documents - those are yours), 
57 | just keep a reference to this repo or to the license info below:
58 | 
59 | ```
60 | Copyright 2013 Google Inc. All Rights Reserved.
61 | 
62 | Licensed under the Apache License, Version 2.0 (the "License");
63 | you may not use this file except in compliance with the License.
64 | You may obtain a copy of the License at
65 | 
66 |     http://www.apache.org/licenses/LICENSE-2.0
67 | 
68 | Unless required by applicable law or agreed to in writing, software
69 | distributed under the License is distributed on an "AS IS" BASIS,
70 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
71 | See the License for the specific language governing permissions and
72 | limitations under the License.
73 | ```
74 | 


--------------------------------------------------------------------------------
/converttomarkdown.gapps:
--------------------------------------------------------------------------------
  1 | /*
  2 | Usage: 
  3 |   Adding this script to your doc: 
  4 |     - Tools > Script Manager > New
  5 |     - Select "Blank Project", then paste this code in and save.
  6 |   Running the script:
  7 |     - Tools > Script Manager
  8 |     - Select "ConvertToMarkdown" function.
  9 |     - Click Run button.
 10 |     - Converted doc will be mailed to you. Subject will be "[MARKDOWN_MAKER]...".
 11 | */
 12 | 
 13 | function ConvertToMarkdown() {
 14 |   var numChildren = DocumentApp.getActiveDocument().getActiveSection().getNumChildren();
 15 |   var text = "";
 16 |   var inSrc = false;
 17 |   var inClass = false;
 18 |   var globalImageCounter = 0;
 19 |   var globalListCounters = {};
 20 |   // edbacher: added a variable for indent in src 
 block. Let style sheet do margin.
 21 |   var srcIndent = "";
 22 |   
 23 |   var attachments = [];
 24 |   
 25 |   // Walk through all the child elements of the doc.
 26 |   for (var i = 0; i < numChildren; i++) {
 27 |     var child = DocumentApp.getActiveDocument().getActiveSection().getChild(i);
 28 |     var result = processParagraph(i, child, inSrc, globalImageCounter, globalListCounters);
 29 |     globalImageCounter += (result && result.images) ? result.images.length : 0;
 30 |     if (result!==null) {
 31 |       if (result.sourcePretty==="start" && !inSrc) {
 32 |         inSrc=true;
 33 |         text+="
\n";
 34 |       } else if (result.sourcePretty==="end" && inSrc) {
 35 |         inSrc=false;
 36 |         text+="
\n\n"; 37 | } else if (result.source==="start" && !inSrc) { 38 | inSrc=true; 39 | text+="
\n";
 40 |       } else if (result.source==="end" && inSrc) {
 41 |         inSrc=false;
 42 |         text+="
\n\n"; 43 | } else if (result.inClass==="start" && !inClass) { 44 | inClass=true; 45 | text+="
\n"; 46 | } else if (result.inClass==="end" && inClass) { 47 | inClass=false; 48 | text+="
\n\n"; 49 | } else if (inClass) { 50 | text+=result.text+"\n\n"; 51 | } else if (inSrc) { 52 | text+=(srcIndent+escapeHTML(result.text)+"\n"); 53 | } else if (result.text && result.text.length>0) { 54 | text+=result.text+"\n\n"; 55 | } 56 | 57 | if (result.images && result.images.length>0) { 58 | for (var j=0; j/g, '>'); 82 | } 83 | 84 | // Process each child element (not just paragraphs). 85 | function processParagraph(index, element, inSrc, imageCounter, listCounters) { 86 | // First, check for things that require no processing. 87 | if (element.getNumChildren()==0) { 88 | return null; 89 | } 90 | // Punt on TOC. 91 | if (element.getType() === DocumentApp.ElementType.TABLE_OF_CONTENTS) { 92 | return {"text": "[[TOC]]"}; 93 | } 94 | 95 | // Set up for real results. 96 | var result = {}; 97 | var pOut = ""; 98 | var textElements = []; 99 | var imagePrefix = "image_"; 100 | 101 | // Handle Table elements. Pretty simple-minded now, but works for simple tables. 102 | // Note that Markdown does not process within block-level HTML, so it probably 103 | // doesn't make sense to add markup within tables. 104 | if (element.getType() === DocumentApp.ElementType.TABLE) { 105 | textElements.push("
\n"); 106 | var nCols = element.getChild(0).getNumCells(); 107 | for (var i = 0; i < element.getNumChildren(); i++) { 108 | textElements.push(" \n"); 109 | // process this row 110 | for (var j = 0; j < nCols; j++) { 111 | textElements.push(" \n"); 112 | } 113 | textElements.push(" \n"); 114 | } 115 | textElements.push("
" + element.getChild(i).getChild(j).getText() + "
\n"); 116 | } 117 | 118 | // Process various types (ElementType). 119 | for (var i = 0; i < element.getNumChildren(); i++) { 120 | var t=element.getChild(i).getType(); 121 | 122 | if (t === DocumentApp.ElementType.TABLE_ROW) { 123 | // do nothing: already handled TABLE_ROW 124 | } else if (t === DocumentApp.ElementType.TEXT) { 125 | var txt=element.getChild(i); 126 | pOut += txt.getText(); 127 | textElements.push(txt); 128 | } else if (t === DocumentApp.ElementType.INLINE_IMAGE) { 129 | result.images = result.images || []; 130 | var contentType = element.getChild(i).getBlob().getContentType(); 131 | var extension = ""; 132 | if (/\/png$/.test(contentType)) { 133 | extension = ".png"; 134 | } else if (/\/gif$/.test(contentType)) { 135 | extension = ".gif"; 136 | } else if (/\/jpe?g$/.test(contentType)) { 137 | extension = ".jpg"; 138 | } else { 139 | throw "Unsupported image type: "+contentType; 140 | } 141 | var name = imagePrefix + imageCounter + extension; 142 | imageCounter++; 143 | textElements.push('![image alt text]('+name+')'); 144 | result.images.push( { 145 | "bytes": element.getChild(i).getBlob().getBytes(), 146 | "type": contentType, 147 | "name": name}); 148 | } else if (t === DocumentApp.ElementType.PAGE_BREAK) { 149 | // ignore 150 | } else if (t === DocumentApp.ElementType.HORIZONTAL_RULE) { 151 | textElements.push('* * *\n'); 152 | } else if (t === DocumentApp.ElementType.FOOTNOTE) { 153 | textElements.push(' (NOTE: '+element.getChild(i).getFootnoteContents().getText()+')'); 154 | } else { 155 | throw "Paragraph "+index+" of type "+element.getType()+" has an unsupported child: " 156 | +t+" "+(element.getChild(i)["getText"] ? element.getChild(i).getText():'')+" index="+index; 157 | } 158 | } 159 | 160 | if (textElements.length==0) { 161 | // Isn't result empty now? 162 | return result; 163 | } 164 | 165 | // evb: Add source pretty too. (And abbreviations: src and srcp.) 166 | // process source code block: 167 | if (/^\s*---\s+srcp\s*$/.test(pOut) || /^\s*---\s+source pretty\s*$/.test(pOut)) { 168 | result.sourcePretty = "start"; 169 | } else if (/^\s*---\s+src\s*$/.test(pOut) || /^\s*---\s+source code\s*$/.test(pOut)) { 170 | result.source = "start"; 171 | } else if (/^\s*---\s+class\s+([^ ]+)\s*$/.test(pOut)) { 172 | result.inClass = "start"; 173 | result.className = RegExp.$1; 174 | } else if (/^\s*---\s*$/.test(pOut)) { 175 | result.source = "end"; 176 | result.sourcePretty = "end"; 177 | result.inClass = "end"; 178 | } else if (/^\s*---\s+jsperf\s*([^ ]+)\s*$/.test(pOut)) { 179 | result.text = ''; 182 | } else { 183 | 184 | prefix = findPrefix(inSrc, element, listCounters); 185 | 186 | var pOut = ""; 187 | for (var i=0; i): 224 | if (gt === DocumentApp.GlyphType.BULLET 225 | || gt === DocumentApp.GlyphType.HOLLOW_BULLET 226 | || gt === DocumentApp.GlyphType.SQUARE_BULLET) { 227 | prefix += "* "; 228 | } else { 229 | // Ordered list (
    ): 230 | var key = listItem.getListId() + '.' + listItem.getNestingLevel(); 231 | var counter = listCounters[key] || 0; 232 | counter++; 233 | listCounters[key] = counter; 234 | prefix += counter+". "; 235 | } 236 | } 237 | } 238 | return prefix; 239 | } 240 | 241 | function processTextElement(inSrc, txt) { 242 | if (typeof(txt) === 'string') { 243 | return txt; 244 | } 245 | 246 | var pOut = txt.getText(); 247 | if (! txt.getTextAttributeIndices) { 248 | return pOut; 249 | } 250 | 251 | var attrs=txt.getTextAttributeIndices(); 252 | var lastOff=pOut.length; 253 | 254 | for (var i=attrs.length-1; i>=0; i--) { 255 | var off=attrs[i]; 256 | var url=txt.getLinkUrl(off); 257 | var font=txt.getFontFamily(off); 258 | if (url) { // start of link 259 | if (i>=1 && attrs[i-1]==off-1 && txt.getLinkUrl(attrs[i-1])===url) { 260 | // detect links that are in multiple pieces because of errors on formatting: 261 | i-=1; 262 | off=attrs[i]; 263 | url=txt.getLinkUrl(off); 264 | } 265 | pOut=pOut.substring(0, off)+'['+pOut.substring(off, lastOff)+']('+url+')'+pOut.substring(lastOff); 266 | } else if (font) { 267 | if (!inSrc && font===font.COURIER_NEW) { 268 | while (i>=1 && txt.getFontFamily(attrs[i-1]) && txt.getFontFamily(attrs[i-1])===font.COURIER_NEW) { 269 | // detect fonts that are in multiple pieces because of errors on formatting: 270 | i-=1; 271 | off=attrs[i]; 272 | } 273 | pOut=pOut.substring(0, off)+'`'+pOut.substring(off, lastOff)+'`'+pOut.substring(lastOff); 274 | } 275 | } 276 | if (txt.isBold(off)) { 277 | var d1 = d2 = "**"; 278 | if (txt.isItalic(off)) { 279 | // edbacher: changed this to handle bold italic properly. 280 | d1 = "**_"; d2 = "_**"; 281 | } 282 | pOut=pOut.substring(0, off)+d1+pOut.substring(off, lastOff)+d2+pOut.substring(lastOff); 283 | } else if (txt.isItalic(off)) { 284 | pOut=pOut.substring(0, off)+'*'+pOut.substring(off, lastOff)+'*'+pOut.substring(lastOff); 285 | } 286 | lastOff=off; 287 | } 288 | return pOut; 289 | } 290 | --------------------------------------------------------------------------------