kitabu 2.1.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (92) hide show
  1. checksums.yaml +5 -5
  2. data/.github/CODEOWNERS +4 -0
  3. data/.github/FUNDING.yml +4 -0
  4. data/.github/ISSUE_TEMPLATE/bug_report.md +41 -0
  5. data/.github/ISSUE_TEMPLATE/config.yml +5 -0
  6. data/.github/ISSUE_TEMPLATE/feature_request.md +23 -0
  7. data/.github/PULL_REQUEST_TEMPLATE.md +38 -0
  8. data/.github/dependabot.yml +15 -0
  9. data/.github/workflows/ruby-tests.yml +61 -0
  10. data/.rubocop.yml +17 -0
  11. data/CHANGELOG.md +13 -2
  12. data/CODE_OF_CONDUCT.md +74 -0
  13. data/CONTRIBUTING.md +79 -0
  14. data/Gemfile +2 -0
  15. data/LICENSE.md +20 -0
  16. data/README.md +103 -88
  17. data/Rakefile +7 -0
  18. data/bin/kitabu +4 -0
  19. data/kitabu.gemspec +21 -15
  20. data/lib/kitabu/cli.rb +54 -39
  21. data/lib/kitabu/dependency.rb +11 -5
  22. data/lib/kitabu/errors.rb +2 -0
  23. data/lib/kitabu/exporter/base.rb +11 -11
  24. data/lib/kitabu/exporter/css.rb +6 -15
  25. data/lib/kitabu/exporter/epub.rb +23 -17
  26. data/lib/kitabu/exporter/html.rb +27 -21
  27. data/lib/kitabu/exporter/mobi.rb +7 -1
  28. data/lib/kitabu/exporter/pdf.rb +9 -3
  29. data/lib/kitabu/exporter.rb +15 -16
  30. data/lib/kitabu/extensions/rouge.rb +6 -1
  31. data/lib/kitabu/extensions/string.rb +5 -3
  32. data/lib/kitabu/footnotes/base.rb +2 -0
  33. data/lib/kitabu/footnotes/html.rb +18 -13
  34. data/lib/kitabu/footnotes/pdf.rb +17 -11
  35. data/lib/kitabu/generator.rb +13 -8
  36. data/lib/kitabu/helpers.rb +12 -9
  37. data/lib/kitabu/markdown.rb +12 -10
  38. data/lib/kitabu/source_list.rb +15 -12
  39. data/lib/kitabu/stats.rb +3 -1
  40. data/lib/kitabu/syntax/highlight.rb +4 -11
  41. data/lib/kitabu/toc/epub.rb +5 -2
  42. data/lib/kitabu/toc/html/stream.rb +3 -1
  43. data/lib/kitabu/toc/html.rb +12 -8
  44. data/lib/kitabu/version.rb +4 -2
  45. data/lib/kitabu.rb +8 -10
  46. data/spec/kitabu/cli/export_spec.rb +6 -4
  47. data/spec/kitabu/cli/new_spec.rb +6 -4
  48. data/spec/kitabu/cli/permalinks_spec.rb +4 -2
  49. data/spec/kitabu/cli/stats_spec.rb +19 -15
  50. data/spec/kitabu/cli/version_spec.rb +3 -1
  51. data/spec/kitabu/exporter/css_spec.rb +3 -1
  52. data/spec/kitabu/exporter/epub_spec.rb +2 -0
  53. data/spec/kitabu/exporter/html_spec.rb +11 -9
  54. data/spec/kitabu/exporter/mobi_spec.rb +5 -5
  55. data/spec/kitabu/exporter/pdf_spec.rb +8 -4
  56. data/spec/kitabu/extensions/string_spec.rb +14 -9
  57. data/spec/kitabu/footnotes/html_spec.rb +35 -33
  58. data/spec/kitabu/generator_spec.rb +3 -1
  59. data/spec/kitabu/markdown_spec.rb +8 -6
  60. data/spec/kitabu/source_list_spec.rb +8 -2
  61. data/spec/kitabu/stats_spec.rb +10 -6
  62. data/spec/kitabu/toc/html_spec.rb +37 -21
  63. data/spec/spec_helper.rb +23 -8
  64. data/spec/support/exit_with_code.rb +7 -5
  65. data/spec/support/have_tag.rb +44 -32
  66. data/spec/support/helper.rb +5 -3
  67. data/spec/support/mybook/code/code.rb +2 -0
  68. data/spec/support/mybook/config/helper.rb +2 -0
  69. data/spec/support/shared.rb +8 -6
  70. data/templates/Gemfile +5 -3
  71. data/templates/Guardfile +3 -1
  72. data/templates/helper.rb +8 -6
  73. data/templates/templates/styles/epub.css +1 -0
  74. data/templates/templates/styles/files/normalize.css +351 -0
  75. data/templates/templates/styles/{html.scss → html.css} +28 -26
  76. data/templates/templates/styles/{pdf.scss → pdf.css} +49 -47
  77. data/templates/templates/styles/print.css +2 -0
  78. data/templates/text/01_Getting_Started.md +27 -9
  79. data/templates/text/02_Creating_Chapters.md +9 -3
  80. data/templates/text/{03_Syntax_Highlighting.erb → 03_Syntax_Highlighting.md.erb} +12 -7
  81. data/templates/text/04_Dynamic_Content.md.erb +48 -0
  82. data/templates/text/05_Exporting_Files.md +17 -8
  83. metadata +40 -48
  84. data/.gitmodules +0 -3
  85. data/.travis.yml +0 -18
  86. data/lib/kitabu/exporter/txt.rb +0 -18
  87. data/spec/kitabu/exporter/txt_spec.rb +0 -14
  88. data/templates/ebook.png +0 -0
  89. data/templates/templates/styles/epub.scss +0 -1
  90. data/templates/templates/styles/files/_normalize.scss +0 -427
  91. data/templates/templates/styles/print.scss +0 -2
  92. data/templates/text/04_Dynamic_Content.erb +0 -64
@@ -1,427 +0,0 @@
1
- /*! normalize.css v3.0.2 | MIT License | git.io/normalize */
2
-
3
- /**
4
- * 1. Set default font family to sans-serif.
5
- * 2. Prevent iOS text size adjust after orientation change, without disabling
6
- * user zoom.
7
- */
8
-
9
- html {
10
- font-family: sans-serif; /* 1 */
11
- -ms-text-size-adjust: 100%; /* 2 */
12
- -webkit-text-size-adjust: 100%; /* 2 */
13
- }
14
-
15
- /**
16
- * Remove default margin.
17
- */
18
-
19
- body {
20
- margin: 0;
21
- }
22
-
23
- /* HTML5 display definitions
24
- ========================================================================== */
25
-
26
- /**
27
- * Correct `block` display not defined for any HTML5 element in IE 8/9.
28
- * Correct `block` display not defined for `details` or `summary` in IE 10/11
29
- * and Firefox.
30
- * Correct `block` display not defined for `main` in IE 11.
31
- */
32
-
33
- article,
34
- aside,
35
- details,
36
- figcaption,
37
- figure,
38
- footer,
39
- header,
40
- hgroup,
41
- main,
42
- menu,
43
- nav,
44
- section,
45
- summary {
46
- display: block;
47
- }
48
-
49
- /**
50
- * 1. Correct `inline-block` display not defined in IE 8/9.
51
- * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera.
52
- */
53
-
54
- audio,
55
- canvas,
56
- progress,
57
- video {
58
- display: inline-block; /* 1 */
59
- vertical-align: baseline; /* 2 */
60
- }
61
-
62
- /**
63
- * Prevent modern browsers from displaying `audio` without controls.
64
- * Remove excess height in iOS 5 devices.
65
- */
66
-
67
- audio:not([controls]) {
68
- display: none;
69
- height: 0;
70
- }
71
-
72
- /**
73
- * Address `[hidden]` styling not present in IE 8/9/10.
74
- * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22.
75
- */
76
-
77
- [hidden],
78
- template {
79
- display: none;
80
- }
81
-
82
- /* Links
83
- ========================================================================== */
84
-
85
- /**
86
- * Remove the gray background color from active links in IE 10.
87
- */
88
-
89
- a {
90
- background-color: transparent;
91
- }
92
-
93
- /**
94
- * Improve readability when focused and also mouse hovered in all browsers.
95
- */
96
-
97
- a:active,
98
- a:hover {
99
- outline: 0;
100
- }
101
-
102
- /* Text-level semantics
103
- ========================================================================== */
104
-
105
- /**
106
- * Address styling not present in IE 8/9/10/11, Safari, and Chrome.
107
- */
108
-
109
- abbr[title] {
110
- border-bottom: 1px dotted;
111
- }
112
-
113
- /**
114
- * Address style set to `bolder` in Firefox 4+, Safari, and Chrome.
115
- */
116
-
117
- b,
118
- strong {
119
- font-weight: bold;
120
- }
121
-
122
- /**
123
- * Address styling not present in Safari and Chrome.
124
- */
125
-
126
- dfn {
127
- font-style: italic;
128
- }
129
-
130
- /**
131
- * Address variable `h1` font-size and margin within `section` and `article`
132
- * contexts in Firefox 4+, Safari, and Chrome.
133
- */
134
-
135
- h1 {
136
- font-size: 2em;
137
- margin: 0.67em 0;
138
- }
139
-
140
- /**
141
- * Address styling not present in IE 8/9.
142
- */
143
-
144
- mark {
145
- background: #ff0;
146
- color: #000;
147
- }
148
-
149
- /**
150
- * Address inconsistent and variable font size in all browsers.
151
- */
152
-
153
- small {
154
- font-size: 80%;
155
- }
156
-
157
- /**
158
- * Prevent `sub` and `sup` affecting `line-height` in all browsers.
159
- */
160
-
161
- sub,
162
- sup {
163
- font-size: 75%;
164
- line-height: 0;
165
- position: relative;
166
- vertical-align: baseline;
167
- }
168
-
169
- sup {
170
- top: -0.5em;
171
- }
172
-
173
- sub {
174
- bottom: -0.25em;
175
- }
176
-
177
- /* Embedded content
178
- ========================================================================== */
179
-
180
- /**
181
- * Remove border when inside `a` element in IE 8/9/10.
182
- */
183
-
184
- img {
185
- border: 0;
186
- }
187
-
188
- /**
189
- * Correct overflow not hidden in IE 9/10/11.
190
- */
191
-
192
- svg:not(:root) {
193
- overflow: hidden;
194
- }
195
-
196
- /* Grouping content
197
- ========================================================================== */
198
-
199
- /**
200
- * Address margin not present in IE 8/9 and Safari.
201
- */
202
-
203
- figure {
204
- margin: 1em 40px;
205
- }
206
-
207
- /**
208
- * Address differences between Firefox and other browsers.
209
- */
210
-
211
- hr {
212
- -moz-box-sizing: content-box;
213
- box-sizing: content-box;
214
- height: 0;
215
- }
216
-
217
- /**
218
- * Contain overflow in all browsers.
219
- */
220
-
221
- pre {
222
- overflow: auto;
223
- }
224
-
225
- /**
226
- * Address odd `em`-unit font size rendering in all browsers.
227
- */
228
-
229
- code,
230
- kbd,
231
- pre,
232
- samp {
233
- font-family: monospace, monospace;
234
- font-size: 1em;
235
- }
236
-
237
- /* Forms
238
- ========================================================================== */
239
-
240
- /**
241
- * Known limitation: by default, Chrome and Safari on OS X allow very limited
242
- * styling of `select`, unless a `border` property is set.
243
- */
244
-
245
- /**
246
- * 1. Correct color not being inherited.
247
- * Known issue: affects color of disabled elements.
248
- * 2. Correct font properties not being inherited.
249
- * 3. Address margins set differently in Firefox 4+, Safari, and Chrome.
250
- */
251
-
252
- button,
253
- input,
254
- optgroup,
255
- select,
256
- textarea {
257
- color: inherit; /* 1 */
258
- font: inherit; /* 2 */
259
- margin: 0; /* 3 */
260
- }
261
-
262
- /**
263
- * Address `overflow` set to `hidden` in IE 8/9/10/11.
264
- */
265
-
266
- button {
267
- overflow: visible;
268
- }
269
-
270
- /**
271
- * Address inconsistent `text-transform` inheritance for `button` and `select`.
272
- * All other form control elements do not inherit `text-transform` values.
273
- * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera.
274
- * Correct `select` style inheritance in Firefox.
275
- */
276
-
277
- button,
278
- select {
279
- text-transform: none;
280
- }
281
-
282
- /**
283
- * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
284
- * and `video` controls.
285
- * 2. Correct inability to style clickable `input` types in iOS.
286
- * 3. Improve usability and consistency of cursor style between image-type
287
- * `input` and others.
288
- */
289
-
290
- button,
291
- html input[type="button"], /* 1 */
292
- input[type="reset"],
293
- input[type="submit"] {
294
- -webkit-appearance: button; /* 2 */
295
- cursor: pointer; /* 3 */
296
- }
297
-
298
- /**
299
- * Re-set default cursor for disabled elements.
300
- */
301
-
302
- button[disabled],
303
- html input[disabled] {
304
- cursor: default;
305
- }
306
-
307
- /**
308
- * Remove inner padding and border in Firefox 4+.
309
- */
310
-
311
- button::-moz-focus-inner,
312
- input::-moz-focus-inner {
313
- border: 0;
314
- padding: 0;
315
- }
316
-
317
- /**
318
- * Address Firefox 4+ setting `line-height` on `input` using `!important` in
319
- * the UA stylesheet.
320
- */
321
-
322
- input {
323
- line-height: normal;
324
- }
325
-
326
- /**
327
- * It's recommended that you don't attempt to style these elements.
328
- * Firefox's implementation doesn't respect box-sizing, padding, or width.
329
- *
330
- * 1. Address box sizing set to `content-box` in IE 8/9/10.
331
- * 2. Remove excess padding in IE 8/9/10.
332
- */
333
-
334
- input[type="checkbox"],
335
- input[type="radio"] {
336
- box-sizing: border-box; /* 1 */
337
- padding: 0; /* 2 */
338
- }
339
-
340
- /**
341
- * Fix the cursor style for Chrome's increment/decrement buttons. For certain
342
- * `font-size` values of the `input`, it causes the cursor style of the
343
- * decrement button to change from `default` to `text`.
344
- */
345
-
346
- input[type="number"]::-webkit-inner-spin-button,
347
- input[type="number"]::-webkit-outer-spin-button {
348
- height: auto;
349
- }
350
-
351
- /**
352
- * 1. Address `appearance` set to `searchfield` in Safari and Chrome.
353
- * 2. Address `box-sizing` set to `border-box` in Safari and Chrome
354
- * (include `-moz` to future-proof).
355
- */
356
-
357
- input[type="search"] {
358
- -webkit-appearance: textfield; /* 1 */
359
- -moz-box-sizing: content-box;
360
- -webkit-box-sizing: content-box; /* 2 */
361
- box-sizing: content-box;
362
- }
363
-
364
- /**
365
- * Remove inner padding and search cancel button in Safari and Chrome on OS X.
366
- * Safari (but not Chrome) clips the cancel button when the search input has
367
- * padding (and `textfield` appearance).
368
- */
369
-
370
- input[type="search"]::-webkit-search-cancel-button,
371
- input[type="search"]::-webkit-search-decoration {
372
- -webkit-appearance: none;
373
- }
374
-
375
- /**
376
- * Define consistent border, margin, and padding.
377
- */
378
-
379
- fieldset {
380
- border: 1px solid #c0c0c0;
381
- margin: 0 2px;
382
- padding: 0.35em 0.625em 0.75em;
383
- }
384
-
385
- /**
386
- * 1. Correct `color` not being inherited in IE 8/9/10/11.
387
- * 2. Remove padding so people aren't caught out if they zero out fieldsets.
388
- */
389
-
390
- legend {
391
- border: 0; /* 1 */
392
- padding: 0; /* 2 */
393
- }
394
-
395
- /**
396
- * Remove default vertical scrollbar in IE 8/9/10/11.
397
- */
398
-
399
- textarea {
400
- overflow: auto;
401
- }
402
-
403
- /**
404
- * Don't inherit the `font-weight` (applied by a rule above).
405
- * NOTE: the default cannot safely be changed in Chrome and Safari on OS X.
406
- */
407
-
408
- optgroup {
409
- font-weight: bold;
410
- }
411
-
412
- /* Tables
413
- ========================================================================== */
414
-
415
- /**
416
- * Remove most spacing between table cells.
417
- */
418
-
419
- table {
420
- border-collapse: collapse;
421
- border-spacing: 0;
422
- }
423
-
424
- td,
425
- th {
426
- padding: 0;
427
- }
@@ -1,2 +0,0 @@
1
- @import './files/normalize';
2
- @import './pdf';
@@ -1,64 +0,0 @@
1
- ## Dynamic Content
2
-
3
- Sometimes you may find useful to generate content dynamically. Maybe you're going to read some configuration file, or maybe you just want to define some helpers. Kitabu has support for ERb files; all you need to do is naming your text file as `.erb`.
4
-
5
- On the previous chapter, we listed all supported Rouge lexers. To do that, I created a helper that looks like this:
6
-
7
- ```ruby
8
- module Kitabu
9
- module Helpers
10
- def lexers_list
11
- buffer = '<ul class="lexers">'
12
-
13
- Rouge::Lexers.constants.each do |const|
14
- lexer = Rouge::Lexers.const_get(const)
15
-
16
- begin
17
- title = lexer.title
18
- tag = lexer.tag
19
- description = lexer.desc
20
- rescue Exception => e
21
- next
22
- end
23
-
24
- buffer << '<li>'
25
- buffer << "<strong>#{title}</strong> "
26
- buffer << "<code>#{tag}</code><br>"
27
- buffer << "<span>#{description}</span>"
28
- buffer << '</li>'
29
- end
30
-
31
- buffer << '</ul>'
32
- buffer
33
- end
34
- end
35
- end
36
- ```
37
-
38
- To use it, I just needed to add `<%%= lexers_list %>` to my text file. This allows you to create anything you need!
39
-
40
- Kitabu comes with some built-in helpers, such as `note`. With this helper, you can create a note that generates a HTML structure, so you can easily style it. The syntax for using the `note` helper is `note(type, &block)`.
41
-
42
- ```erb
43
- <%% note do %>
44
- Some text that will be parsed as Markdown.
45
- <%% end %>
46
- ```
47
-
48
- By default, this will generate a `<div class="note info">` tag, but you can use anything you want.
49
-
50
- ```erb
51
- <%% note :warning do %>
52
- Some text that will be parsed as Markdown.
53
- <%% end %>
54
- ```
55
-
56
- [Check out the source](https://github.com/fnando/kitabu/blob/cleanup/lib/kitabu/helpers.rb) for a sample on how to create block helpers like `note`.
57
-
58
- ### Escaping ERb code
59
-
60
- If you want to write a book about Rails, you're likely to use lots of ERb tags. In this case, make sure you escape the `<%% %>` and `<%%= %>` markers as `<%%% %>` and `<%%%= %>`; otherwise you'll have a syntax error.
61
-
62
- ```
63
- <%%%= Date.today %>
64
- ```