miyano 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b823029ec906b1777e99a40b47582edf6b52e8ceb771c08373998b3378c564d
-  data.tar.gz: 954993e76b9d8ec3af5fffd17ba233fa318c2c862ff6c71a5f3aeba8b13f0f8e
+  metadata.gz: f4c8716a655275f663f46943dfdda0948a225dbecf213dc62daa7d75b572e331
+  data.tar.gz: 12ee7daa04863ac11b23bb920067e16ee2dc7c1454ad0c42e8f4ef80f03b5198
 SHA512:
-  metadata.gz: c226da4a6ea3b9c98d281da36b1d77d6553e0be88c9138936d9515471af1cca169e42e5a2dbe02f3f27080a695773b28f7da7195ecea7a8f37b0fedee3e0fccc
-  data.tar.gz: 3965ed4c7aeae2f6143ae6f9506e07170c64029b53d02718c8be6e612fd26c035fa489f9f9f9fbe090b1b9ead0921f114fd8ed620655a8b831788b2c262e9338
+  metadata.gz: ce82a1a1026710b080eeee0e422aab0d6b1855cf469904bf02a26f2774b86c17f66fc02aef89fdf3bc760b8b4b8523e8ee692d846437a1fd1229267ba5b6df37
+  data.tar.gz: 8e42d9496e9dbe82cb1e2aa096269e802b4d33b2490203393a743d741ff2c44c76a20b5acf5e0dfe306cf73ccdc7f894620470942183cd125a29a724c9bcfb58

data/README.md

@@ -1,18 +1,20 @@
 # Miyano
 
-Example: https://yuxin.io
+Example(my blog): https://yuxin.io
 
-Guide: https://yuxin.io/introduce_miyano/
+Not a big thing like [Jekyll](https://jekyllrb.com) which lets you feel free to deep DIY you blog.
 
-Not a big thing like [Jekyll](https://jekyllrb.com) which makes you feel free to deep DIY you blog.
-
-The big thing brings free but also along with the complex, which needs you to pay more attention to the
-attributes or the property of the post to adapt to the blog system every time you write a post than the **content** itself which is matter.
+The big thing brings free but also along with the complex.
 
 This small tool is designed for [Bear](http://www.bear-writer.com) lovers.
 
 Focus on the right thing - writing the content.
 
+## Requirements
+
+- MacOS
+- Ruby >= 2.5.0
+
 ## Installation
 
     $ gem install miyano
@@ -23,7 +25,7 @@ Focus on the right thing - writing the content.
 
     $ miyano new myblog
 
-**For Markdown Compatibility Mode**
+If you use Bear in **Markdown Compatibility Mode**, use option `-m`
 
     $ miyano new myblog -m
 
@@ -33,17 +35,44 @@ Focus on the right thing - writing the content.
 
 ### Build and Try it
 
-    $ miyano build
+    $ miyano Build // convert the bearnotes to html files
 
-    $ miyano try
+    $ miyano try // start a local server
 
 Then open browser and go to `localhost:8000`
+`Ctrl + C` to Quit
 
-### Push to Github Pages
+### Serve at Github Pages
 
     $ miyano push
 
-**Give a Star to Support me!**
+### Serve at VPS (Not Recommended)
+(cause it's not free and not stable as Github Pages)
+
+You need to config the git server at the VPS, and `miyano push` to that server.
+Then don't use the `miyano try` as a Web Server, use `Nginx` instead.
+
+### Themes
+Not friendly enough.
+
+The `layout` folder determines how the blog looks like. 
+I use `erb` as a template.
+
+The `index.html.erb` has the instance of Class `Site`, check the methods you can use in the source [lib/miyano/site.rb](https://github.com/wuusn/miyano/blob/master/lib/miyano/site.rb).
+
+Similarly, the `post.html.erb` has a instance of Class `Post`, check [lib/miyano/post.rb](https://github.com/wuusn/miyano/blob/master/lib/miyano/post.rb).
+
+
+## Parser of  Polar Bear Markup Language
+I made these parsers, [beardown](https://github.com/wuusn/beardown) and [beardown-compat](https://github.com/wuusn/beardown-compat).
+
+If you find any error render(different from the Bear App), contact me
+or open an issue in [Beardown Issues](https://github.com/wuusn/beardown/issues)
+
+## Join the Telegram Group to get support
+[Miyano for Bear](https://t.me/m1yano)
+
+## If you like it, please give a star to let me know
 
 ## Contributing
 

data/lib/miyano/cli.rb

@@ -13,9 +13,9 @@ module Miyano
     desc "new [DIR]", "create new blog"
     method_option :compat, :aliases => "-m", :desc => "Markdown Compatibility Mode"
     def new(dir)
-      compat = options[:compat]? "_compat" : ""
-      url = "https://github.com/wuusn/miyano_template#{compat}.git"
+      url = "https://github.com/wuusn/miyano_template.git"
       `git clone --depth 1 #{url} #{dir}`
+      `touch #{dir}/post/.compat` if options[:compat]
       `rm -rf #{dir}/.git*`
     end
 

data/lib/miyano/version.rb

@@ -1,3 +1,3 @@
 module Miyano
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miyano
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - wuusn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2018-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler