miyano 0.3.1 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7b823029ec906b1777e99a40b47582edf6b52e8ceb771c08373998b3378c564d
4
- data.tar.gz: 954993e76b9d8ec3af5fffd17ba233fa318c2c862ff6c71a5f3aeba8b13f0f8e
3
+ metadata.gz: f4c8716a655275f663f46943dfdda0948a225dbecf213dc62daa7d75b572e331
4
+ data.tar.gz: 12ee7daa04863ac11b23bb920067e16ee2dc7c1454ad0c42e8f4ef80f03b5198
5
5
  SHA512:
6
- metadata.gz: c226da4a6ea3b9c98d281da36b1d77d6553e0be88c9138936d9515471af1cca169e42e5a2dbe02f3f27080a695773b28f7da7195ecea7a8f37b0fedee3e0fccc
7
- data.tar.gz: 3965ed4c7aeae2f6143ae6f9506e07170c64029b53d02718c8be6e612fd26c035fa489f9f9f9fbe090b1b9ead0921f114fd8ed620655a8b831788b2c262e9338
6
+ metadata.gz: ce82a1a1026710b080eeee0e422aab0d6b1855cf469904bf02a26f2774b86c17f66fc02aef89fdf3bc760b8b4b8523e8ee692d846437a1fd1229267ba5b6df37
7
+ data.tar.gz: 8e42d9496e9dbe82cb1e2aa096269e802b4d33b2490203393a743d741ff2c44c76a20b5acf5e0dfe306cf73ccdc7f894620470942183cd125a29a724c9bcfb58
data/README.md CHANGED
@@ -1,18 +1,20 @@
1
1
  # Miyano
2
2
 
3
- Example: https://yuxin.io
3
+ Example(my blog): https://yuxin.io
4
4
 
5
- Guide: https://yuxin.io/introduce_miyano/
5
+ Not a big thing like [Jekyll](https://jekyllrb.com) which lets you feel free to deep DIY you blog.
6
6
 
7
- Not a big thing like [Jekyll](https://jekyllrb.com) which makes you feel free to deep DIY you blog.
8
-
9
- The big thing brings free but also along with the complex, which needs you to pay more attention to the
10
- 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.
7
+ The big thing brings free but also along with the complex.
11
8
 
12
9
  This small tool is designed for [Bear](http://www.bear-writer.com) lovers.
13
10
 
14
11
  Focus on the right thing - writing the content.
15
12
 
13
+ ## Requirements
14
+
15
+ - MacOS
16
+ - Ruby >= 2.5.0
17
+
16
18
  ## Installation
17
19
 
18
20
  $ gem install miyano
@@ -23,7 +25,7 @@ Focus on the right thing - writing the content.
23
25
 
24
26
  $ miyano new myblog
25
27
 
26
- **For Markdown Compatibility Mode**
28
+ If you use Bear in **Markdown Compatibility Mode**, use option `-m`
27
29
 
28
30
  $ miyano new myblog -m
29
31
 
@@ -33,17 +35,44 @@ Focus on the right thing - writing the content.
33
35
 
34
36
  ### Build and Try it
35
37
 
36
- $ miyano build
38
+ $ miyano Build // convert the bearnotes to html files
37
39
 
38
- $ miyano try
40
+ $ miyano try // start a local server
39
41
 
40
42
  Then open browser and go to `localhost:8000`
43
+ `Ctrl + C` to Quit
41
44
 
42
- ### Push to Github Pages
45
+ ### Serve at Github Pages
43
46
 
44
47
  $ miyano push
45
48
 
46
- **Give a Star to Support me!**
49
+ ### Serve at VPS (Not Recommended)
50
+ (cause it's not free and not stable as Github Pages)
51
+
52
+ You need to config the git server at the VPS, and `miyano push` to that server.
53
+ Then don't use the `miyano try` as a Web Server, use `Nginx` instead.
54
+
55
+ ### Themes
56
+ Not friendly enough.
57
+
58
+ The `layout` folder determines how the blog looks like.
59
+ I use `erb` as a template.
60
+
61
+ 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).
62
+
63
+ 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).
64
+
65
+
66
+ ## Parser of Polar Bear Markup Language
67
+ I made these parsers, [beardown](https://github.com/wuusn/beardown) and [beardown-compat](https://github.com/wuusn/beardown-compat).
68
+
69
+ If you find any error render(different from the Bear App), contact me
70
+ or open an issue in [Beardown Issues](https://github.com/wuusn/beardown/issues)
71
+
72
+ ## Join the Telegram Group to get support
73
+ [Miyano for Bear](https://t.me/m1yano)
74
+
75
+ ## If you like it, please give a star to let me know
47
76
 
48
77
  ## Contributing
49
78
 
data/lib/miyano/cli.rb CHANGED
@@ -13,9 +13,9 @@ module Miyano
13
13
  desc "new [DIR]", "create new blog"
14
14
  method_option :compat, :aliases => "-m", :desc => "Markdown Compatibility Mode"
15
15
  def new(dir)
16
- compat = options[:compat]? "_compat" : ""
17
- url = "https://github.com/wuusn/miyano_template#{compat}.git"
16
+ url = "https://github.com/wuusn/miyano_template.git"
18
17
  `git clone --depth 1 #{url} #{dir}`
18
+ `touch #{dir}/post/.compat` if options[:compat]
19
19
  `rm -rf #{dir}/.git*`
20
20
  end
21
21
 
@@ -1,3 +1,3 @@
1
1
  module Miyano
2
- VERSION = "0.3.1"
2
+ VERSION = "0.3.2"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: miyano
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.1
4
+ version: 0.3.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - wuusn
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2018-03-12 00:00:00.000000000 Z
11
+ date: 2018-03-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler