enwrite 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab868ce535c913c7f1bda420ccc50ea9e8c8629a
-  data.tar.gz: a53cf60fcfea16cb3f3aac2816966c507bde662e
+  metadata.gz: 41ff65583cf68c9ac604768f8b61527ef296e2e0
+  data.tar.gz: a71a84427e5d203841a7f8be48a5cf72386604f4
 SHA512:
-  metadata.gz: b973cf1e94be664f7155636dc3621009f15ef3907727a0541e5f93a0cdc2066eb24a1de997169a35308b631d0ad5ef24a96659870a660b644c47fecbf4e30915
-  data.tar.gz: 1eec8e7fd2222e735878bd3383261a7e42b0f7c71734ab5f3d2aa72a5d8b0ab8372c2f2843179973d3882c34a89f595f1df22e3a857ca553b23a6ef50aeacec7
+  metadata.gz: a0ad71fde41b53fb975e1966ad07c62edcc874066cbf94eb7fc0fabd78cca3fa7089ed7c71d580bd4164cae2e48282433399a2f0d3cc46c20032a116061c0dd1
+  data.tar.gz: 3da4d70e1ddfddde94df2f9f41a6c7f3336120effde5aaacb1606c6dda9281b28c2b661442696278ca3b6d22b2980d6b56af1d6a066864a327835f9db9a641bb

data/README.md

@@ -15,13 +15,16 @@ provide the authentication code to Enwrite.
 For now it produces output suitable for [Hugo](http://gohugo.io). You
 need to have an existing Hugo install.
 
-## Getting started
+## Installation
+
+    $ sudo gem install enwrite
 
-Install using gem:
+Make sure you have Hugo installed:
+http://gohugo.io/overview/installing/
 
-    $ gem install enwrite
+## Getting started
 
-Create a new Hugo site for testing (if you don't have one already):
+Create a new Hugo site for testing:
 
     $ cd ~/tmp
     $ hugo new site my-hugo-blog
@@ -30,7 +33,7 @@ Create a new Hugo site for testing (if you don't have one already):
 Populate it with contents from Evernote:
 
     $ enwrite --help
-    Enwrite v0.2.0
+    Enwrite v0.2.3
     
     Usage: /usr/local/bin/enwrite [options] (at least one of -n or -s has to be specified)
     
@@ -56,8 +59,8 @@ Populate it with contents from Evernote:
                                          interactively.
             --config-tag TAG             Specify tag to determine config notes
                                          (default: _enwrite_config)
-            --verbose                    Verbose mode
-        -v, --debug                      Debug output mode
+        -v, --verbose                    Verbose mode
+        -d, --debug                      Debug output mode
             --version                    Show version
         -h, --help                       Shows this help message
 
@@ -83,6 +86,8 @@ file types are stored and linked to with their filename.
 The following tags trigger special behavior if found within the
 selected notes:
 
+### Globally-recognized tags
+
 - `page`: publish the note as a page instead of a blog post.
 - `post` (or none): publish the note as a blog post. This is the
 default.
@@ -94,6 +99,7 @@ default.
   about this will be written soon). For example, if you wanted blog
   posts to be stored in the Hugo `blog` category instead of `post`,
   you could include this:
+
   ```
   hugo:
       tag_to_type:
@@ -101,38 +107,68 @@ default.
           post: blog/
           page:
   ```
+
+### Hugo-specific tags
+
+The following tags are recognized by the Hugo output plugin (the only
+one available at the moment):
+
 - `_enwrite_files_hugo`: text in these notes is ignored, but any
   attachments are stored under the Hugo output directory. `.tar.gz`
   files will be unpacked under that directory, all others will be
-  stored as-is.
-
-Any of these special tags are removed from the post before publishing
-(you can configure additional ones with the `--remove-tags`
-option). All other tags are passed through to the produced posts. Of
-course, you could have some of those tags also trigger special
-behavior within the output system. For example, my
-[custom Hugo theme](https://github.com/zzamboni/new/tree/master/themes/hyde-x-zzamboni)
-recognizes the following tags:
+  stored as-is. You can use this to have Hugo config files, themes,
+  static contents or anything else automatically installed by Enwrite
+  as well. Please note that any "files" notes *must also* be included
+  in the selection criteria specified by `-n`, `-t` or `-s` (e.g. if
+  you are using `-t published`, your files notes must also be tagged
+  `published` or they will be ignored).
+
+  Any text in files notes will be ignored, so you can use it to make
+  it human-readable. For example, I have the following note in the
+  notebook that powers http://zzamboni.org/new/, so I can start from a
+  plain Hugo site and have it fully customized after running
+  `enwrite`:
+  
+  ![Files note screenshot](https://www.evernote.com/shard/s2/sh/828dbfcd-83ff-493c-a247-493ed0704e73/fb8ffb0e1e417dd6/res/eaa1ca47-3cb1-4c4d-963e-815cfd83bd00/skitch.png)
 
-- `_home`: set this page as the default for the site. This is
-  dependent on the Hugo theme being used.
-- `_mainmenu`: add this page to the top-level navigation menu. This is
-  dependent on the Hugo theme being used.
+- Any tags of the form `_foo=bar` are inserted into the frontmatter
+  for the generated posts as field `foo` with value `bar`. This might
+  be used to add information (e.g. a custom `slug`, specify `weight` for
+  ordeing of pages, or any other field which may control the behavior or
+  output produced.
   
+## Other tags
+
+All the special tags described above are removed from the post before
+publishing (you can configure additional ones to remove with the
+`--remove-tags` option). All other tags are passed through to the
+produced posts. Of course, you could have some of those tags also
+trigger special behavior within the output system. For example, my
+[custom Hyde-X Hugo theme](https://github.com/zzamboni/new/tree/master/themes/hyde-x-zzamboni)
+recognizes the following tags:
+
+- `_home`: set this page as the default for the site.
+- `_menu=main`: add this page to the top-level navigation menu.
+
 ## Shortcuts
 
-The following shortcuts are recognized:
+Shortcuts are of the form `[shortcutname params]`. The following
+shortcuts are currently recognized:
 
-Embed Youtube video by URL or ID. You can optionally specify `width`
-and `height`. All arguments must be enclosed in double quotes.
+- Embed Youtube video by URL or ID. You can optionally specify `width`
+  and `height`. All arguments must be enclosed in double quotes.
 
-    [youtube url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"]
-    [youtube src="https://www.youtube.com/watch?v=dQw4w9WgXcQ"]
-    [youtube id="dQw4w9WgXcQ" width="640px" height="480px"]
+  ```
+[youtube url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"]
+[youtube src="https://www.youtube.com/watch?v=dQw4w9WgXcQ"]
+[youtube id="dQw4w9WgXcQ" width="640px" height="480px"]
+  ```
 
-Embed gist:
+- Embed gist.
 
-    [gist url="https://gist.github.com/zzamboni/843142d3f759e582fe8f"]
+  ```
+[gist url="https://gist.github.com/zzamboni/843142d3f759e582fe8f"]
+  ```
 
 ## Planned features/fixes
 

data/enwrite.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: enwrite 0.2.3 ruby lib
+# stub: enwrite 0.2.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "enwrite"
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Diego Zamboni"]
-  s.date = "2015-05-15"
+  s.date = "2015-05-20"
   s.description = "Enwrite allows you to generate a website from content stored in Evernote."
   s.email = "diego@zzamboni.org"
   s.executables = ["enwrite"]

data/lib/enwrite.rb

@@ -22,7 +22,7 @@ class Enwrite
   module Version
     MAJOR = 0
     MINOR = 2
-    PATCH = 3
+    PATCH = 4
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

data/lib/output/hugo.rb

@@ -107,18 +107,12 @@ class Hugo < Output
       return
     end
 
-    # Determine if we should include the page in the main menu
-    inmainmenu = note.tagNames.include?('_mainmenu')
-    if inmainmenu
-      note.tagNames -= [ '_mainmenu' ]
-    end
-
-    # Determine if we should use a custom slug
-    slug = nil
-    note.tagNames.grep(/^_slug=(\S+)/) do |slugtag|
-      slug = $1
-      note.tagNames -= [ slugtag ]
-      verbose "   Will use custom slug for this post: #{slug}"
+    # Determine if we should add custom frontmatter
+    custom_fm = {}
+    note.tagNames.grep(/^_(\S+)=(.*)/) do |tag|
+      custom_fm[$1] = $2
+      note.tagNames -= [ tag ]
+      verbose "   Will use custom frontmatter entry for this post: #{$1} = #{custom_fm[$1]}"
     end
 
     # Get our note GUID-to-filename map
@@ -173,10 +167,12 @@ class Hugo < Output
           # Update tags, for now set categories to the same
           frontmatter['tags'] = note.tagNames
           frontmatter['categories'] = note.tagNames
+          # Set custom frontmatter
+          custom_fm.each do |k,v|
+            frontmatter[k] = v
+          end
           # Set slug to work around https://github.com/spf13/hugo/issues/1017
-          frontmatter['slug'] = slug ? slug : note.title.downcase.gsub(/\W+/, "-").gsub(/^-+/, "").gsub(/-+$/, "")
-          # Set main menu tag if needed
-          frontmatter['menu'] = 'main' if inmainmenu
+          frontmatter['slug'] = custom_fm['slug'] ? custom_fm['slug'] : note.title.downcase.gsub(/\W+/, "-").gsub(/^-+/, "").gsub(/-+$/, "")
           break
         elsif output =~ /ERROR: \S+ (.+) already exists/
           # Get the full filename as reported by Hugo

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enwrite
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Diego Zamboni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-15 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize