notion_to_md 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df84120caddccce07f99e140867a59ca176ee9c639a019785ef74faea03de32b
+  data.tar.gz: 5d95ff8014362018d505944b3b1afaf6593fac9f3f90cab28f6abd645843b39f
+SHA512:
+  metadata.gz: 24a41732b091218c1c3b9b428714419a9ce993669d5edde0baa011cfb6953cb4db433aa8dc4536670577062b7a304b4d686361b756580800afcb72ebe2ab95b1
+  data.tar.gz: c2a9e707c602366f8f9e5d811c7010a65cdcf7c0a6fff17353b3a04a5cc28db7be452e453c5ee218b24a007c1c5d753aefb44c443c77e16cec1028097fcc71bf

data/README.md

@@ -0,0 +1,2 @@
+# notion_to_md
+Notion Markdown Exporter in Ruby

data/lib/notion_to_md/converter.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require 'notion'
+require_relative './logger'
+require_relative './text_annotation'
+
+module NotionToMd
+  class Converter
+    attr_reader :page_id
+
+    def initialize(page_id:, token: nil)
+      @notion = Notion::Client.new(token: token || ENV['NOTION_TOKEN'])
+      @page_id = page_id
+    end
+
+    def convert
+      md = page_blocks[:results].map do |block|
+        next blank if block[:type] == 'paragraph' && block.dig(:paragraph, :text).empty?
+
+        block_type = block[:type].to_sym
+        send(block_type, block[block_type])
+      end
+      Logger.info("Notion page #{page_id} converted to markdown")
+      md.join("\n\n")
+    end
+
+    private
+
+    def page_blocks
+      @page_blocks ||= @notion.block_children(id: page_id)
+    end
+
+
+    def paragraph(block)
+      convert_text(block)
+    end
+
+    def heading_1(block)
+      "# #{convert_text(block)}"
+    end
+
+    def heading_2(block)
+      "## #{convert_text(block)}"
+    end
+
+    def heading_3(block)
+      "### #{convert_text(block)}"
+    end
+
+    def callout(block)
+      icon = get_icon(block[:icon])
+      text = convert_text(block)
+      "#{icon} #{text}"
+    end
+
+    def quote(block)
+      "> #{convert_text(block)}"
+    end
+
+    def bulleted_list_item(block)
+      "- #{convert_text(block)}"
+    end
+
+    # TODO: numbered_list_item
+    def numbered_list_item(block)
+      Logger.info('numbered_list_item type not supported. Shown as bulleted_list_item.')
+      bulleted_list_item(block)
+    end
+
+    def to_do(block)
+      checked = block[:checked]
+      text = convert_text(block)
+
+      "- #{checked ? '[x]' : '[ ]'} #{text}"
+    end
+
+    def code(block)
+      language = block[:language]
+      text = convert_text(block)
+
+      "```#{language}\n\t#{text}\n```"
+    end
+
+    def embed(block)
+      url = block[:url]
+
+      "[#{url}](#{url})"
+    end
+
+    def image(block)
+      type = block[:type].to_sym
+      url = block.dig(type, :url)
+      caption = convert_caption(block)
+
+      "![](#{url})\n\n#{caption}"
+    end
+
+    def bookmark(block)
+      url = block[:url]
+      "[#{url}](#{url})"
+    end
+
+    def divider(_block)
+      '---'
+    end
+
+    def equation(block)
+      equ = convert_text(block)
+      "$$ #{equ} $$"
+    end
+
+    def blank
+      '<br />'
+    end
+
+    def convert_text(block)
+      block[:text].map do |text|
+        content = text[:plain_text]
+        enrich_text_content(text, content)
+      end.join
+    end
+
+    def convert_caption(block)
+      convert_text(text: block[:caption])
+    end
+
+    def get_icon(block)
+      type = block[:type].to_sym
+      block[type]
+    end
+
+    def enrich_text_content(text, content)
+      enriched_content = add_link(text, content)
+      add_annotations(text, enriched_content)
+    end
+
+    def add_link(text, content)
+      href = text[:href]
+      return content if href.nil?
+
+      "[#{content}](#{href})"
+    end
+
+    def add_annotations(text, content)
+      annotations = text[:annotations].select { |key, value| !!value }
+      annotations.keys.inject(content) do |enriched_content, annotation|
+        TextAnnotation.send(annotation.to_sym, enriched_content)
+      end
+    end
+  end
+end

data/lib/notion_to_md/logger.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module NotionToMd
+  class Logger
+    @logger = ::Logger.new(STDOUT)
+
+    class << self
+      extend Forwardable
+      def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+    end
+  end
+end
+
+

data/lib/notion_to_md/text_annotation.rb

@@ -0,0 +1,36 @@
+module NotionToMd
+  # Append the text type:
+  # * italic: boolean,
+  # * bold: boolean,
+  # * striketrough: boolean,
+  # * underline: boolean,
+  # * code: boolean,
+  # * color: string NOT_SUPPORTED
+  class TextAnnotation
+    class << self
+      def italic(text)
+        "_#{text}_"
+      end
+
+      def bold(text)
+        "**#{text}**"
+      end
+
+      def striketrough(text)
+        "~~#{text}~~"
+      end
+
+      def underline(text)
+        text
+      end
+
+      def code(text)
+        "`#{text}`"
+      end
+
+      def color(text)
+        text
+      end
+    end
+  end
+end

data/lib/notion_to_md/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NotionToMd
+  VERSION = '0.0.0'
+end

data/lib/notion_to_md.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative './notion_to_md/version'
+require_relative './notion_to_md/converter'

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: notion_to_md
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Enrique Arias
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: notion-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+description: Notion Markdown Exporter in Ruby
+email: emoriarty81@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/notion_to_md.rb
+- lib/notion_to_md/converter.rb
+- lib/notion_to_md/logger.rb
+- lib/notion_to_md/text_annotation.rb
+- lib/notion_to_md/version.rb
+homepage: https://github.com/emoriarty/notion_to_md
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Notion Markdown Exporter
+test_files: []