jekyll-notion 0.0.0.alpha.2 → 0.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c85349b9010ff1ccbbc88b83e46315f8e31bc9b489943dce0c75c7a503820db3
-  data.tar.gz: f0ae3ebe202b1cd3d184fe232d350b6024148a2bffe298a771c9221e1ac0684b
+  metadata.gz: bc64ea093044b7a8b5f0f1059e175d439b8b70fc1b4b08a30ea39438b4dc6d46
+  data.tar.gz: 608c37287a98f0ce89184616c27392048c9fdc725ab77f327e0cffb35fa4020b
 SHA512:
-  metadata.gz: 1c98f9f772b8290d78e0ab393c5dbd55b419518a9f9baccd84906218e6a650d903027f10b85f120a779c71364f9a3d3ec2d8bd88fddf284f59fe2ffc80c1e3de
-  data.tar.gz: 0fe7d15ad3c33de0929072ad7ba7df7f8c0ed22cb4aefb9084bfc868a2aa23641c08d3f1d8f6c22b8ac35b765b938a2e2798f02a028a2c37e4d41d4bfa51fca0
+  metadata.gz: 6c1b27117aee99b01dd988d243d1419b054447aa5afb02e5cffc5ed9120a8acd2e3a0b11759cccf6bd28a8657bc65e147307be501b2140421e961d48920c0f4d
+  data.tar.gz: cb1fbc6a9edb4069fd8019e5a29837bdf80a551c119a9371d7678f48ca10a32e58c5a5da2edbe4c4bff0c41d6d560041db0fbf9a26fdeb0bcf9101cd88d3cabd

data/README.md

@@ -1,2 +1,59 @@
 # jekyll-notion
-Import pages from notion.
+
+Import notion pages to a jekyll collection.
+
+## Installation
+
+Use gem to install.
+```bash
+$ gem install 'jekyll-notion'
+```
+
+Or add it to the `Gemfile`.
+```ruby
+# Gemfile
+gem 'jekyll-notion'
+```
+
+And update your jekyll plugins property in `_config.yml`.
+
+```yml
+plugins:
+  - jekyll-notion
+```
+
+## Setup
+
+Before using the gem create an integration and generate a secret token. Check [notion getting started guide](https://developers.notion.com/docs/getting-started) to learn more.
+
+Export the notion secret token in an environment variable named `NOTION_TOKEN`.
+
+```bash
+$ export NOTION_TOKEN=<secret_...>
+```
+
+Once your notion database has been shared, specify the `id` in your `_config.yml` as follows.
+
+```yml
+notion:
+  database:
+    id: b91d5...
+    collection: posts
+    layout: post
+    filter: { "property": "Published", "checkbox": { "equals": true } }
+    sort: { "propery": "Last ordered", "direction": "ascending" }
+    frontmatter:
+      prop_1: blabla
+      prop_2: albalb
+```
+
+The other properties are:
+* `collection`: what collection each page belongs to,
+* `layout`: the collection layout,
+* `filter`: the database query filter,
+* `sort`: the database query sort,
+* `frontmatter`: additonal frontmatter to append to each page in the collection.
+
+Note: Only one database is available.
+
+And that's all. Each page in the notion database will be included in the selected collection.

data/lib/jekyll-notion/generator.rb

@@ -10,17 +10,25 @@ module JekyllNotion
 
     def generate(site)
       @site = site
+
+      return unless notion_token?
+      return unless config?
+
+      read_notion_database
+    end
+
+    def read_notion_database
       @db = NotionDatabase.new(config: config)
       @db.pages do |page|
         @current_page = page
-        site.posts.docs << make_page
-        Jekyll.logger.info("New page from notion", site.posts.docs.last.path)
+        collection.docs << make_page
+        Jekyll.logger.info('Jekyll Notion:', "New notion page at #{collection.docs.last.path}")
       end
     end
 
     def make_page
       new_post = DocumentWithoutAFile.new(
-        "#{Dir.pwd}/_#{config['collection']}/#{make_filename}",
+        "#{Dir.pwd}/_#{config.dig('database', 'collection')}/#{make_filename}",
         { site: @site, collection: collection }
       )
       new_post.content = "#{make_frontmatter}\n\n#{make_md}"
@@ -34,7 +42,7 @@ module JekyllNotion
 
     def make_frontmatter
       <<-CONTENT
-#{config['frontmatter'].to_yaml}
+#{config.dig('database', 'frontmatter').to_yaml}
 id: #{current_page.id}
 layout: #{current_page.layout}
 title: #{current_page.title}
@@ -49,11 +57,27 @@ cover: #{current_page.cover}
     end
 
     def collection
-      @site.send(config['collection'].to_sym)
+      @site.send(config.dig('database', 'collection').to_sym)
     end
 
     def config
       @config ||= @site.config["notion"] || {}
     end
+
+    def notion_token?
+      if ENV['NOTION_TOKEN'].nil? || ENV['NOTION_TOKEN'].empty?
+        Jekyll.logger.error('Jekyll Notion:', 'NOTION_TOKEN not provided. Cannot read from Notion.')
+        return false
+      end
+      true
+    end
+
+    def config?
+      if config.empty?
+        Jekyll.logger.error('Jekyll Notion:', 'No config provided.')
+        return false
+      end
+      true
+    end
   end
 end

data/lib/jekyll-notion/notion_database.rb

@@ -9,7 +9,7 @@ module JekyllNotion
 
     def pages
       @pages ||= @notion.database_query(query)[:results].map do |page|
-        NotionPage.new(page: page, layout: @config['layout'])
+        NotionPage.new(page: page, layout: config['layout'])
       end
       
       return @pages unless block_given?
@@ -19,6 +19,10 @@ module JekyllNotion
 
     private
 
+    def config
+      @config['database']
+    end
+
     def filter
       @config.dig('database', 'filter')
     end

data/lib/jekyll-notion/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllNotion
-  VERSION = '0.0.0.alpha.2'
+  VERSION = '0.0.0.beta'
 end

data/lib/jekyll-notion.rb

@@ -10,7 +10,7 @@ require 'jekyll-notion/generator'
 NotionToMd::Logger.level = Logger::ERROR
 
 Notion.configure do |config|
-    config.token = ENV['NOTION_TOKEN']
+  config.token = ENV['NOTION_TOKEN']
 end
 
 module JekyllNotion

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-notion
 version: !ruby/object:Gem::Version
-  version: 0.0.0.alpha.2
+  version: 0.0.0.beta
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport