docx2gfm 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: d9a2da3b4b09ea75ecb7523a3a01e0b275237239acea98dbc20c1371afa8a3ea
-  data.tar.gz: 35624ce545980e73a9f931be6f94d5fb7e2c642a8854d2c75d1041cc9d3cb9d4
+SHA1:
+  metadata.gz: 48b802854f6a5c4bb63e5f5ddfd7ef4842b29c4b
+  data.tar.gz: 39f9a4b1b9bc5a97cf4907c0d187fb5bbfa9be74
 SHA512:
-  metadata.gz: '0861e90f7edda3bb08c31f7e5963e3ed7db5866f9bb2e61787aa40a0ee2b48c3ca2d00dab1e44411df635004d2796f1025456979fb7ad46e291d0aec72ad88af'
-  data.tar.gz: e7a5df12dc792018f6c4ff469289e8d5d16cfc4feccfc62a2b507af11163778616ff0c3632f4a9cd398486abb26673abbb78df571c8851d76bd87e7b1d4684e7
+  metadata.gz: e13b9887d88360f5d134669a906ddd11a0bc5f37199b6064078e1fad18068764def38a1369b2951b3eabd0d07efb2a09102f36a8ae3104746104030302b3813e
+  data.tar.gz: 0b2657892ce806f007532c3a67691c99a4a7699c1198dee0275807dc67fa9499f89bd6b97f522ba7b736eac95a1dec3c244a171567773dbb64cb85278a04cbe2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Sebastian Spier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,14 +1,16 @@
 # docx2gfm - docx to github-flavored-markdown converter
 
-If you need to convert `.docx` documents to markdown, then `docx2gfm` is for you, as it makes the process faster.
+If you need to convert `.docx` documents to markdown, then `docx2gfm` helps you to make the process faster.
 
-"Don't tell me, show. me"! Ok ok! `docx2gfm` turns [this docx file](./examples/sample.docx) into [this markdown](./examples/sample.md). Also see the original [google Doc][gDoc].
+"Don't tell me, show me"! Ok ok! `docx2gfm` turns [this docx file](./examples/sample.docx) into [this markdown](./examples/sample.md). Also see the original [google Doc][gDoc].
 
-Some post-processing of the markdown is still required but `docx2gfm` already makes the conversion process much faster.
+For another example of `docx2gfm` in action, take a look at this blog post [docx2gfm - Your friendly docx to markdown converter][blog-post].
+
+While some post-processing of the markdown is still required,  `docx2gfm` already makes the conversion process much faster.
 
 ## The Long Story
 
-I am maintaining an engineering blog, that uses [jekyll][jekyll] to generate static pages.
+I am [maintaining an engineering blog][uth-tech-stack], that uses [jekyll][jekyll] to generate static pages.
 
 In our blogging process, the authors write blog post as a Google Doc to collect feedback. Once the post is ready for publishing, they convert the Google Doc to [github-flavored-markdown][gfm], as that is what [jekyll][jekyll] needs as input to render the HTML for the blog.
 
@@ -50,10 +52,10 @@ Usage: docx2gfm [options]
 The markdown produced by `docx2gfm` is good but not perfect. You still have to do some manual steps:
 
 * Adapt the YAML Frontmatter (if you used the `--jekyll` option)
-* Add the correct image links
-* Add code blocks
-* Add quotes
-* Add tables
+* Add the correct image paths
+* Double check code blocks
+* Double check quotes
+* Double check tables
 
 ## Alternatives to docx2gfm
 
@@ -80,3 +82,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 [gDoc]: https://docs.google.com/document/d/16Kww2ic-YgFKskfDxYJu6o_ooSF3IORJh8Ho7XbgngI/edit
 [pandoc]: https://pandoc.org/installing.html
 [jekyll]: https://jekyllrb.com
+[blog-post]: https://spier.hu/2018/12/docx2gfm-your-friendly-docx-to-markdown-converter
+[uth-tech-stack]: https://spier.hu/2019/11/a-simple-tech-stack-for-your-engineering-blog

data/lib/docx2gfm/docx_gfm_converter.rb

@@ -6,12 +6,12 @@ class DocxGfmConverter
   end
 
   # perform all conversation and cleanup steps
-  def process_gfm()
-    docx_2_gfm(@options[:file])
-    cleanup_content_gfm()
-    create_ref_style_links() if @options[:ref_style_links]
-    add_frontmatter() if @options[:jekyll]
-  end
+  # def process_gfm()
+  #   docx_2_gfm(@options[:file])
+  #   cleanup_content_gfm()
+  #   create_ref_style_links() if @options[:ref_style_links]
+  #   add_frontmatter() if @options[:jekyll]
+  # end
 
   def process_markdown()
     docx_2_markdown(@options[:file])
@@ -26,16 +26,16 @@ class DocxGfmConverter
   end
 
   # convert docx to initial markdown
-  def docx_2_gfm(file)
-    # TODO before reading the file, I could check if the file exists
-    # TODO check out pandoc options that might be useful e.g. --extract-media='/images/own/'
-    @content = `pandoc #{file} -f docx -t gfm --wrap=none`
-  end
+  # def docx_2_gfm(file)
+  #   # TODO before reading the file, I could check if the file exists
+  #   # TODO check out pandoc options that might be useful e.g. --extract-media='/images/own/'
+  #   @content = `pandoc #{file} -f docx -t gfm --wrap=none`
+  # end
 
   def docx_2_markdown(file)
     # TODO before reading the file, I could check if the file exists
     # TODO check out pandoc options that might be useful e.g. --extract-media='/images/own/'
-    @content = `pandoc #{file} --wrap=none --atx-headers -f docx -t markdown-bracketed_spans-link_attributes-smart-simple_tables -s`
+    @content = `pandoc '#{file}' --wrap=none --atx-headers -f docx -t markdown-bracketed_spans-link_attributes-smart-simple_tables -s`
   end
 
   # this removes all sorts of strange stuff that pandoc generates when

data/lib/docx2gfm/version.rb

@@ -1,3 +1,3 @@
 module Docx2gfm
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/docx2gfm.rb

@@ -32,6 +32,10 @@ module Docx2gfm
           puts opts
           exit
         end
+        opts.on('-v', '--version', 'Show version of docx2gfm') do
+          puts Docx2gfm::VERSION
+          exit
+        end
       end
 
       # most useful way of creating a required parameter with OptionParser

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docx2gfm
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sebastian Spier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-17 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -49,6 +49,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- LICENSE
 - LICENSE.txt
 - MOTIVATION.md
 - README.md
@@ -84,7 +85,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Convert a docx file, to github-flavored-markdown