hugo-notion 0.1.0.pre.alpha.3 → 0.1.0.pre.alpha.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +52 -0
  3. data/lib/hugo_notion/version.rb +1 -1
  4. metadata +5 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 998722740c86d07e77edb0bcfa625cf6cd9c956f90a525cf1146604324ed26bd
4
- data.tar.gz: 596a6adb5d21930ea0a46beb2a4cd7e1a3d309d18f2dd2ade153e9d8414f70e5
3
+ metadata.gz: a01cd4d000a8b5bbd92c8dace6bb7d74a251fd218e9bdc301989edabd746f85e
4
+ data.tar.gz: 66bf11b69e4282460933c7932be0c91842f43b01882d8605821fd04a2d4d82a9
5
5
  SHA512:
6
- metadata.gz: d44e9c969c40cdcbabcfd0442aa7577b54c31865910dc4cf51a268545f8fd1c76e705c64540e6e678284e48782227cf17dd048ccffd7793d17171b5222ea9f84
7
- data.tar.gz: 6269bf536477e430f23912f0cc23e1b5a4a4eeb184e64afb38a918efbd602eb678b0d5776dbb383e960cd42f8d607f11caf703a76be26e62ea253c0fb323d423
6
+ metadata.gz: c591d6f8e60da2199d8a39dc8c0bb87e89009d394f2b1cbf066576ef8e99d8f0b8923769aec24ca4a6cab7ccc8e1382786c61c612f01983929c7562462bcd8ba
7
+ data.tar.gz: bcfe59b27d295ba72b0c62e0d6b0dc67a53f66d20a23f09259c3d435c2c1c6fa25d4c17191a108c3117255ab23b0fdef0ff01c86aaa092674dc2af84715bf89f
data/README.md CHANGED
@@ -1,3 +1,55 @@
1
1
  # hugo-notion
2
2
 
3
3
  Write in Notion. Publish with Hugo.
4
+
5
+ ## Installation
6
+
7
+ ```
8
+ gem install hugo-notion --prerelease
9
+ ```
10
+
11
+ Installing the `hugo-notion` ruby gem will install the `huno` command.
12
+
13
+ ## Usage
14
+
15
+ First, create a Notion integration, generate a secret and connect that integration to the Notion page https://developers.notion.com/docs/create-a-notion-integration#getting-started
16
+
17
+ Go to your Hugo site directory and run
18
+
19
+ ```
20
+ NOTION_TOKEN=your_notion_secret huno your_notion_page_url
21
+ ```
22
+
23
+ `huno` will sync your Notion page and its children pages to the `content` directory.
24
+
25
+ If you're yet to move your Hugo pages to Notion, you can use my "blog_content" Notion page as a template https://www.notion.so/blog_content-0f1b55769779411a95df1ee9b4b070c9
26
+
27
+ ## Tips
28
+
29
+ If you'd like `huno` to sync Notion pages to a different directory, you can do that too
30
+
31
+ ```
32
+ NOTION_TOKEN=your_notion_secret huno your_notion_page_url site_content/
33
+ ```
34
+
35
+ To avoid having to provide the `NOTION_TOKEN` env var again and again, you can create a `.env` file
36
+
37
+ ```
38
+ echo 'NOTION_TOKEN=your_notion_secret' > .env
39
+ ```
40
+
41
+ To run `huno` say, every 15 seconds, use the `watch` command
42
+
43
+ ```
44
+ watch -n15 huno your_notion_page_url
45
+ ```
46
+
47
+ If you're on MacOS and don't have the `watch` command installed, you can use Homebrew to install it
48
+
49
+ ```
50
+ brew install watch
51
+ ```
52
+
53
+ ## Bug Reports
54
+
55
+ If you'd like to report a bug (if there are any, please do), please create a GitHub issue
@@ -1,3 +1,3 @@
1
1
  class HugoNotion
2
- VERSION = '0.1.0-alpha.3'
2
+ VERSION = '0.1.0-alpha.4'
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: hugo-notion
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0.pre.alpha.3
4
+ version: 0.1.0.pre.alpha.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Nisanth Chunduru
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-04-16 00:00:00.000000000 Z
11
+ date: 2024-04-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: httparty
@@ -66,7 +66,7 @@ dependencies:
66
66
  - - ">="
67
67
  - !ruby/object:Gem::Version
68
68
  version: '0'
69
- description: Write in Notion. Publish with Hugo.
69
+ description: Use Notion as a CMS (Content Management System) for your Hugo site
70
70
  email:
71
71
  - nisanth074@gmail.com
72
72
  executables:
@@ -79,7 +79,8 @@ files:
79
79
  - lib/hugo_notion/synchronizer.rb
80
80
  - lib/hugo_notion/version.rb
81
81
  homepage: https://github.com/nisanthchunduru/hugo-notion
82
- licenses: []
82
+ licenses:
83
+ - MIT
83
84
  metadata: {}
84
85
  post_install_message:
85
86
  rdoc_options: []