jekyll-hk-api-doc 1.0.1 → 1.1.0

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.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +15 -0
  3. data/_includes/api_main_content.html +8 -8
  4. data/_sass/include.api_main_content.scss +52 -1
  5. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 806d12a4a70e3962c2f4ea25d33a7c2c053b2a47f95771a54bdf2f95b4cdfe78
4
- data.tar.gz: 6a2c924a09210dffd947d214b92816e26f20706c8a259d2b92d246026e843714
3
+ metadata.gz: 813828256529a5b047abea76565902509db8910632e6454b072f5fd971fcc395
4
+ data.tar.gz: 61b639e6009c78e4533d4ddff4a0f5daa41d66eac40dfd1000a81a91f0d9c956
5
5
  SHA512:
6
- metadata.gz: efb517671a86061da99e180741836f5be7c9d75604c2d800ac96fcd70ce8eb707ec3cb7145011c611c8c6c833e68d90a155eecac4e0ee260a55d92ea6a97c412
7
- data.tar.gz: 2625b14c3d809566dc285ea1e562f451335792f302c4a49f7cf05dcde61dba21414a442ace86525ed68037b4075c856f069cdf08e99642aa35f93d0d330425ba
6
+ metadata.gz: 438f5ea9e9b58cdc5d3a1cc982b1f7a6549b4bc65fe98a277a9220c2ef2d0d4598ce9753c6e7c7a4e03fea56084cf08efcf89172f751ceed595eaaa5e8a5da24
7
+ data.tar.gz: f0660835680a85b71d01758ba991f5c06fab38e9688ad663ddb3942f598dfa46975b3f743f4a14850d1445a767c89fb796ae0b96a4e075af856f9821084425de
data/README.md CHANGED
@@ -147,3 +147,18 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Heekan
147
147
  ## License
148
148
 
149
149
  The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
150
+
151
+ ## Version Log
152
+
153
+ ### v1.0.0
154
+
155
+ Accidently commited. Currently yanked.
156
+
157
+ ### v1.0.1
158
+
159
+ First version.
160
+
161
+ ### v1.1.0
162
+
163
+ - support list(<ul>, <ol>) in description keys
164
+ - support markdown in description keys
data/_includes/api_main_content.html CHANGED
@@ -1,7 +1,7 @@
1
1
  <div class="main-content">
2
2
  <div class="yaml-name-area">
3
3
  <h1 class="yaml-name">{{ yaml.name }}</h1>
4
- <p class="yaml-description">{{ yaml.description | newline_to_br }}</p>
4
+ <div class="yaml-description">{{ yaml.description | markdownify }}</div>
5
5
  </div>
6
6
 
7
7
  <div class="apis">
@@ -13,7 +13,7 @@
13
13
  <p class="api-url-area"><span class="api-baseurl">{{ site.api_baseurl | escape }}</span><span class="api-url">{{ yaml.baseurl | escape }}{{ api.url | escape }}</span></p>
14
14
  </div>
15
15
 
16
- <div class="api-description">{{ api.description | newline_to_br }}</div>
16
+ <div class="api-description">{{ api.description | markdownify }}</div>
17
17
 
18
18
  <div class="request-response-container">
19
19
  <div class="btns">
@@ -44,7 +44,7 @@
44
44
  {% endif %}
45
45
  </td>
46
46
  <td class="param-datatype-col"><p class="param-datatype">{{ param.type }}</p></td>
47
- <td class="param-description-col"><p class="param-description">{{ param.description | newline_to_br }}</p></td>
47
+ <td class="param-description-col"><div class="param-description">{{ param.description | markdownify }}</div></td>
48
48
  </tr>
49
49
  {% endfor %}
50
50
  </tbody>
@@ -72,7 +72,7 @@
72
72
  {% endif %}
73
73
  </td>
74
74
  <td class="param-datatype-col"><p class="param-datatype">{{ param.type }}</p></td>
75
- <td class="param-description-col"><p class="param-description">{{ param.description | newline_to_br }}</p></td>
75
+ <td class="param-description-col"><div class="param-description">{{ param.description | markdownify }}</div></td>
76
76
  </tr>
77
77
  {% endfor %}
78
78
  </tbody>
@@ -100,7 +100,7 @@
100
100
  {% endif %}
101
101
  </td>
102
102
  <td class="param-datatype-col"><p class="param-datatype">{{ param.type }}</p></td>
103
- <td class="param-description-col"><p class="param-description">{{ param.description | newline_to_br }}</p></td>
103
+ <td class="param-description-col"><div class="param-description">{{ param.description | markdownify }}</div></td>
104
104
  </tr>
105
105
  {% endfor %}
106
106
  </tbody>
@@ -128,7 +128,7 @@
128
128
  {% endif %}
129
129
  </td>
130
130
  <td class="param-datatype-col"><p class="param-datatype">{{ param.type }}</p></td>
131
- <td class="param-description-col"><p class="param-description">{{ param.description | newline_to_br }}</p></td>
131
+ <td class="param-description-col"><div class="param-description">{{ param.description | markdownify }}</div></td>
132
132
  </tr>
133
133
  {% endfor %}
134
134
  </tbody>
@@ -150,7 +150,7 @@
150
150
  </p>
151
151
 
152
152
  {% if item.description %}
153
- <p class="response-description">{{ item.description | newline_to_br }}</p>
153
+ <div class="response-description">{{ item.description | markdownify }}</div>
154
154
  {% endif %}
155
155
 
156
156
  {% if item.example %}
@@ -180,7 +180,7 @@
180
180
  </p>
181
181
 
182
182
  {% if item.description %}
183
- <p class="response-description">{{ item.description | newline_to_br }}</p>
183
+ <div class="response-description">{{ item.description | markdownify }}</div>
184
184
  {% endif %}
185
185
 
186
186
  {% if item.example %}
data/_sass/include.api_main_content.scss CHANGED
@@ -1,6 +1,6 @@
1
1
  .main-content {
2
2
  $color-description: #555555;
3
- $line-height: 1.6;
3
+ $line-height: 1.7;
4
4
 
5
5
  padding: {
6
6
  top: 1em;
@@ -15,6 +15,57 @@
15
15
 
16
16
  box-sizing: border-box;
17
17
 
18
+ ul,
19
+ ol {
20
+ margin: {
21
+ bottom: 1em;
22
+ }
23
+ display: table;
24
+ word-break: break-all;
25
+
26
+ li {
27
+ list-style: none;
28
+ display: table-row;
29
+ line-height: $line-height;
30
+
31
+ &::before {
32
+ display: table-cell;
33
+ text-align: right;
34
+ word-break: keep-all;
35
+ padding: {
36
+ right: 0.3em;
37
+ }
38
+ }
39
+
40
+ ol, ul {
41
+ margin: {
42
+ bottom: 0;
43
+ left: 1em;
44
+ }
45
+ }
46
+ }
47
+ }
48
+
49
+ ol {
50
+ counter-reset: listcounter 0;
51
+
52
+ >li {
53
+ &::before {
54
+ content: counter(listcounter) ".";
55
+ counter-increment: listcounter;
56
+ }
57
+ }
58
+ }
59
+
60
+ ul {
61
+ >li {
62
+ &::before {
63
+ content: "\2022";
64
+ font-weight: bold;
65
+ }
66
+ }
67
+ }
68
+
18
69
  .yaml-name-area {
19
70
  padding: {
20
71
  top: 0.2em;
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-hk-api-doc
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.1
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Heekang Park
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-01-15 00:00:00.000000000 Z
11
+ date: 2021-01-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll