j1-template 2022.5.1 → 2022.5.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_includes/themes/j1/procedures/layouts/module_writer.proc +1 -1
- data/assets/data/banner.html +2 -2
- data/assets/data/panel.html +4 -4
- data/assets/themes/j1/adapter/js/attic.js +19 -2
- data/assets/themes/j1/adapter/js/rtable.js +68 -5
- data/assets/themes/j1/adapter/js/scroller.js +7 -0
- data/assets/themes/j1/core/css/vendor.css +5 -6
- data/assets/themes/j1/core/css/vendor.min.css +1 -1
- data/assets/themes/j1/core/js/template.js +2 -1
- data/assets/themes/j1/core/js/template.min.js.map +1 -1
- data/assets/themes/j1/modules/jquery/js/extensions/hasClass.js +20 -0
- data/assets/themes/j1/modules/jquery/js/extensions/removeClass.js +24 -0
- data/assets/themes/j1/modules/rtable/js/rtable.js +22 -16
- data/assets/themes/j1/modules/rtable/js/rtable.min.js +1 -1
- data/assets/themes/j1/modules/themeSwitcher/LICENSE +21 -21
- data/assets/themes/j1/modules/themeSwitcher/README.md +166 -166
- data/lib/j1/commands/app.rb +36 -0
- data/lib/j1/commands/generate.rb +1 -1
- data/lib/j1/commands/patch.rb +1 -1
- data/lib/j1/commands/rebuild.rb +1 -1
- data/lib/j1/commands/reset.rb +1 -1
- data/lib/j1/commands/setup.rb +1 -1
- data/lib/j1/commands/site.rb +1 -1
- data/lib/j1/version.rb +1 -1
- data/lib/j1_app.rb +1 -1
- data/lib/starter_web/Gemfile +1 -1
- data/lib/starter_web/README.md +5 -5
- data/lib/starter_web/_config.yml +1 -1
- data/lib/starter_web/_data/asciidoc2pdf/images/cover/readme +39 -0
- data/lib/starter_web/_data/asciidoc2pdf/themes/base-theme.yml +113 -117
- data/lib/starter_web/_data/asciidoc2pdf/themes/default-for-print-theme.yml +25 -24
- data/lib/starter_web/_data/asciidoc2pdf/themes/default-for-print-with-fallback-font-theme.yml +1 -0
- data/lib/starter_web/_data/asciidoc2pdf/themes/default-theme.yml +215 -212
- data/lib/starter_web/_data/asciidoc2pdf/themes/default-with-fallback-font-theme.yml +9 -5
- data/lib/starter_web/_data/asciidoc2pdf/themes/j1-theme.yml +24 -5
- data/lib/starter_web/_data/blocks/banner.yml +1 -1
- data/lib/starter_web/_data/modules/defaults/rtable.yml +12 -1
- data/lib/starter_web/_data/puma/config.rb +3 -0
- data/lib/starter_web/_data/resources.yml +4 -2
- data/lib/starter_web/_plugins/lunr_index.rb +1 -1
- data/lib/starter_web/assets/images/banner/1280x600/lunr.jpg +0 -0
- data/lib/starter_web/assets/images/{modules/attics/banner/library-1920x800-bw.jpg → banner/1920x800/library.jpg} +0 -0
- data/lib/starter_web/assets/images/banner/scalable/readme +0 -0
- data/lib/starter_web/assets/images/modules/attics/1920x1280/{ev.jpg → _ev.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/1920x1280/_guillaume-bolduc.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/1920x1280/crawford-jolly.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/1920x1280/josh-liu.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/1920x1280/kristopher-roller.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/1920x1280/moritz-kindler.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/1920x1280/nasa.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/{alexander-redl.jpg → _alexander-redl.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/{alexander-shatov-1920x1280.jpg → _alexander-shatov-1920x1280.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/{annie-spratt-1920x1280.jpg → _annie-spratt-1920x1280.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/{antonino-visalli-1920x1280.jpg → _antonino-visalli-1920x1280.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/{christa-dodoo-1920x1280.jpg → _christa-dodoo-1920x1280.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/{guillaume-bolduc-1920x1280.jpg → _guillaume-bolduc-1920x1280.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/{harpal-singh.jpg → _harpal-singh.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/{humble-lamb-1920x1280.jpg → _humble-lamb-1920x1280.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/{john-schnobrich-2-1920x1280.jpg → _john-schnobrich-2-1920x1280.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/{kirklai-1920x1280.jpg → _kirklai-1920x1280.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/{romain-vignes-1920x1280.jpg → _romain-vignes-1920x1280.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/{runner-1920x1200.jpg → _runner-1920x1200.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/{spacex-1920x1280.jpg → _spacex-1920x1280.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/_vladislav-klapin-1920x1280.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/{wrongtog-1920x1280.jpg → _wrongtog-1920x1280.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/{building-blocks-1920x1280-bw.jpg → building-blocks-1920x1280.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/lunr-1280x800.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/{shubham-dhage-2-1920x1280.jpg → shubham-dhage-1920x1280.jpg} +0 -0
- data/lib/starter_web/assets/images/modules/attics/vladislav-klapin-1920x1280.jpg +0 -0
- data/lib/starter_web/collections/posts/public/featured/_posts/2022-02-01-about-j1.adoc +2 -2
- data/lib/starter_web/index.html +23 -18
- data/lib/starter_web/package.json +5 -4
- data/lib/starter_web/pages/public/about/features.adoc +9 -4
- data/lib/starter_web/pages/public/about/reporting_issues.adoc +9 -5
- data/lib/starter_web/pages/public/about/site.adoc +8 -2
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/000_intro.adoc +5 -3
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/100_converter.adoc +3 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/200_themes.adoc +3 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/attributes.asciidoc +2 -1
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/documents/{100_converter/000_basic_example.asciidoc → 000_examples/basic_example.asciidoc} +1 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/documents/100_converter/111_about_the_converter.asciidoc +20 -11
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/documents/100_converter/112_getting_started.asciidoc +76 -24
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/documents/200_themes/211_language_overview.asciidoc +33 -29
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/documents/200_themes/212_values.asciidoc +67 -88
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/documents/200_themes/213_fonts.asciidoc +40 -39
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/images/readme +1 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/tables/math_expressions.asciidoc +19 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/tables/measurement_units.asciidoc +22 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/documentation.adoc +20 -5
- data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/documents/100_chapter.asciidoc +5 -325
- data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/documents/200_chapter.asciidoc +3 -134
- data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/images/readme +1 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/tables/build_command_options.asciidoc +72 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/tables/files_and_folders.asciidoc +66 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/tables/global_configuration_options.asciidoc +63 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/tables/global_variables.asciidoc +26 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/tables/page_variables.asciidoc +54 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/tables/serve_command_options.asciidoc +45 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/tables/site_variables.asciidoc +59 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/multi.adoc +21 -7
- data/lib/starter_web/pages/public/asciidoc_skeletons/simple-document/simple.adoc +124 -122
- data/lib/starter_web/pages/public/blog/navigator/archive/categoryview.html +3 -3
- data/lib/starter_web/pages/public/blog/navigator/archive/dateview.html +3 -3
- data/lib/starter_web/pages/public/blog/navigator/archive/tagview.html +3 -3
- data/lib/starter_web/pages/public/blog/navigator/archive.html +3 -3
- data/lib/starter_web/pages/public/blog/navigator/index.html +3 -3
- data/lib/starter_web/pages/public/features/general.adoc +4 -4
- data/lib/starter_web/pages/public/features/template.adoc +1 -2
- data/lib/starter_web/pages/public/learn/quickstart.adoc +2 -2
- data/lib/starter_web/pages/public/learn/roundtrip/{400_asciidoc_extensions.adoc → asciidoc_extensions.adoc} +2 -2
- data/lib/starter_web/pages/public/learn/roundtrip/{410_bs_modals_extentions.adoc → bs_modals_extentions.adoc} +2 -2
- data/lib/starter_web/pages/public/learn/roundtrip/{300_icon_fonts.adoc → icon_fonts.adoc} +1 -2
- data/lib/starter_web/pages/public/learn/roundtrip/{100_present_images.adoc → present_images.adoc} +10 -10
- data/lib/starter_web/pages/public/learn/roundtrip/{100_present_videos.adoc → present_videos.adoc} +0 -0
- data/lib/starter_web/pages/public/learn/roundtrip/{600_quicksearch.adoc → quicksearch.adoc} +6 -7
- data/lib/starter_web/pages/public/learn/roundtrip/{420_responsive_tables_extensions.adoc → responsive_tables_extensions.adoc} +86 -73
- data/lib/starter_web/pages/public/learn/roundtrip/{500_themes.adoc → themes.adoc} +2 -2
- data/lib/starter_web/pages/public/learn/roundtrip/{200_typography.adoc → typography.adoc} +6 -6
- data/lib/starter_web/pages/public/learn/where_to_go.adoc +2 -2
- data/lib/starter_web/pages/public/legal/de/100_copyright.adoc +3 -2
- data/lib/starter_web/pages/public/legal/de/100_impress.adoc +3 -2
- data/lib/starter_web/pages/public/legal/de/300_privacy.adoc +3 -2
- data/lib/starter_web/pages/public/legal/de/400_comment_policy.adoc +3 -2
- data/lib/starter_web/pages/public/legal/en/100_copyright.adoc +3 -2
- data/lib/starter_web/pages/public/legal/en/200_impress.adoc +3 -2
- data/lib/starter_web/pages/public/legal/en/300_privacy.adoc +3 -2
- data/lib/starter_web/pages/public/legal/en/400_comment_policy.adoc +3 -2
- data/lib/starter_web/pages/public/panels/intro_panel/panel.adoc +2 -2
- data/lib/starter_web/pages/public/plans/plans.adoc +2 -2
- data/lib/starter_web/pages/public/previewer/preview_bootstrap_theme.adoc +5 -5
- data/lib/starter_web/pages/public/se/se-fake.adoc +2 -2
- data/lib/starter_web/utilsrv/_defaults/package.json +1 -1
- data/lib/starter_web/utilsrv/package.json +1 -1
- metadata +56 -38
- data/lib/starter_web/assets/images/modules/attics/1920x1280/ben-kolde.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/1920x1280/braden-collum.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/1920x1280/firmbee-com.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/1920x1280/max-harlynking.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/banner/admin-dashboard-bootstrap-1280x800-bw.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/banner/lunr-banner-1280x800.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/franck-1920x12800.jpg +0 -0
- data/lib/starter_web/assets/images/modules/attics/vladislav-klapin-2-1920x1280.jpg +0 -0
@@ -366,7 +366,9 @@ resources:
|
|
366
366
|
js: [
|
367
367
|
modules/spinner/js/spin,
|
368
368
|
modules/jquery/js/jquery,
|
369
|
-
modules/
|
369
|
+
modules/jquery/js/extensions/hasClass,
|
370
|
+
modules/jquery/js/extensions/removeClass,
|
371
|
+
modules/popper/js/popper,
|
370
372
|
core/js/template
|
371
373
|
]
|
372
374
|
init_function: [ j1.init ]
|
@@ -771,6 +773,7 @@ resources:
|
|
771
773
|
files: [ adapter/js/rtable.js ]
|
772
774
|
js: [ modules/rtable/js/rtable ]
|
773
775
|
init_function: [ j1.adapter.rtable.init ]
|
776
|
+
|
774
777
|
# ----------------------------------------------------------------------------
|
775
778
|
# J1 Asciidoctor, JS functions to (dynamically) modify Asciidoctor HTML elements
|
776
779
|
#
|
@@ -793,7 +796,6 @@ resources:
|
|
793
796
|
js: []
|
794
797
|
init_function: [ j1.adapter.asciidoctor.init ]
|
795
798
|
|
796
|
-
|
797
799
|
# ----------------------------------------------------------------------------
|
798
800
|
# CSS Flags Previewer, preview page (UI) for country flags
|
799
801
|
#
|
Binary file
|
File without changes
|
File without changes
|
File without changes
|
Binary file
|
Binary file
|
data/lib/starter_web/assets/images/modules/attics/{alexander-redl.jpg → _alexander-redl.jpg}
RENAMED
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
data/lib/starter_web/assets/images/modules/attics/{kirklai-1920x1280.jpg → _kirklai-1920x1280.jpg}
RENAMED
File without changes
|
File without changes
|
data/lib/starter_web/assets/images/modules/attics/{runner-1920x1200.jpg → _runner-1920x1200.jpg}
RENAMED
File without changes
|
data/lib/starter_web/assets/images/modules/attics/{spacex-1920x1280.jpg → _spacex-1920x1280.jpg}
RENAMED
File without changes
|
data/lib/starter_web/assets/images/modules/attics/{wrongtog-1920x1280.jpg → _wrongtog-1920x1280.jpg}
RENAMED
File without changes
|
File without changes
|
Binary file
|
File without changes
|
Binary file
|
@@ -5,7 +5,7 @@ tagline: first version for the public is out
|
|
5
5
|
categories: [ Featured ]
|
6
6
|
tags: [ J1, Template, Jekyll ]
|
7
7
|
|
8
|
-
image: /assets/images/modules/attics/
|
8
|
+
image: /assets/images/modules/attics/1920x1280/alexander-redl.jpg
|
9
9
|
|
10
10
|
fab_menu_id: default
|
11
11
|
regenerate: false
|
@@ -18,7 +18,7 @@ resource_options:
|
|
18
18
|
opacity: 0.5
|
19
19
|
slides:
|
20
20
|
|
21
|
-
- url: /assets/images/modules/attics/
|
21
|
+
- url: /assets/images/modules/attics/1920x1280/alexander-redl.jpg
|
22
22
|
alt: Photo by Alex Holyoake on Unsplash
|
23
23
|
title: J1 Template
|
24
24
|
tagline: first version for the public is out
|
data/lib/starter_web/index.html
CHANGED
@@ -52,6 +52,7 @@ regenerate: false
|
|
52
52
|
|
53
53
|
resources: [ animate, iconify, scroller ]
|
54
54
|
resource_options:
|
55
|
+
|
55
56
|
- attic:
|
56
57
|
|
57
58
|
circuit: true
|
@@ -64,37 +65,41 @@ resource_options:
|
|
64
65
|
|
65
66
|
slides:
|
66
67
|
|
67
|
-
- url: /assets/images/modules/attics/
|
68
|
-
alt:
|
69
|
-
title: Jekyll One
|
70
|
-
tagline: explore what j1 can do
|
68
|
+
- url: /assets/images/modules/attics/1920x1280/kristopher-roller.jpg
|
69
|
+
alt: Photo by Kristopher Roller on Unsplash
|
70
|
+
title: Jekyll One Template
|
71
|
+
tagline: explore what j1 can do for your website
|
72
|
+
badge:
|
73
|
+
type: unsplash
|
74
|
+
author: Kristopher Roller
|
75
|
+
href: https://unsplash.com/@krisroller
|
71
76
|
|
72
|
-
- url: /assets/images/modules/attics/1920x1280/
|
73
|
-
alt: Photo by
|
74
|
-
title:
|
77
|
+
- url: /assets/images/modules/attics/1920x1280/moritz-kindler.jpg
|
78
|
+
alt: Photo by Moritz Kindler on Unsplash
|
79
|
+
title: Setup a site in no time
|
75
80
|
tagline: ready to use build-in web available
|
76
81
|
badge:
|
77
82
|
type: unsplash
|
78
|
-
author:
|
79
|
-
href: https://unsplash.com/@
|
83
|
+
author: Moritz Kindler
|
84
|
+
href: https://unsplash.com/@moritz_photography
|
80
85
|
|
81
|
-
- url: /assets/images/modules/attics/1920x1280/
|
82
|
-
alt: Photo by
|
86
|
+
- url: /assets/images/modules/attics/1920x1280/crawford-jolly.jpg
|
87
|
+
alt: Photo by Crawford Jolly on Unsplash
|
83
88
|
title: Create Your Web
|
84
89
|
tagline: build modern, fast and secure websites
|
85
90
|
badge:
|
86
91
|
type: unsplash
|
87
|
-
author:
|
88
|
-
href: https://unsplash.com/@
|
92
|
+
author: Crawford Jolly
|
93
|
+
href: https://unsplash.com/@crawford
|
89
94
|
|
90
|
-
- url: /assets/images/modules/attics/
|
91
|
-
alt: photo by
|
95
|
+
- url: /assets/images/modules/attics/1920x1280/nasa.jpg
|
96
|
+
alt: photo by NASA on Unsplash
|
92
97
|
title: Start using J1 Template
|
93
|
-
tagline: go for rocketstart
|
98
|
+
tagline: go for rocketstart and ready to go in minutes
|
94
99
|
badge:
|
95
100
|
type: unsplash
|
96
|
-
author:
|
97
|
-
href: https://unsplash.com/@
|
101
|
+
author: NASA
|
102
|
+
href: https://unsplash.com/@nasa
|
98
103
|
---
|
99
104
|
|
100
105
|
<pre>
|
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"private": true,
|
3
3
|
"name": "j1",
|
4
|
-
"version": "2022.5.
|
4
|
+
"version": "2022.5.2",
|
5
5
|
"description": "J1 Template Starter Web",
|
6
6
|
"homepage": "https://your.site",
|
7
7
|
"author": {
|
@@ -61,9 +61,10 @@
|
|
61
61
|
},
|
62
62
|
"scripts": {
|
63
63
|
"app": "run-p -s app:*",
|
64
|
-
"app
|
65
|
-
"app:
|
66
|
-
"
|
64
|
+
"j1-app": "run-p -s app:*",
|
65
|
+
"app:rackup": "cross-var cross-env INTERFACE=$npm_package_jekyll_opt_interface PORT=$npm_package_jekyll_opt_app_port bundle exec puma -C _data/puma/config.rb",
|
66
|
+
"_app:jekyll": "cross-var cross-env JEKYLL_ENV=$npm_package_config_mode BUNDLE_GEMFILE=$npm_package_ruby_gemfile bundle exec jekyll b -c $npm_package_jekyll_configfile $npm_package_jekyll_opt_incremental --watch",
|
67
|
+
"_app:open": "npm run delay-3s && cross-var open-cli $npm_package_jekyll_opt_app_url",
|
67
68
|
"delay-1s": "node ./node_modules/npm-delay 1000",
|
68
69
|
"delay-2s": "node ./node_modules/npm-delay 2000",
|
69
70
|
"delay-3s": "node ./node_modules/npm-delay 3000",
|
@@ -13,19 +13,24 @@ tags: [ J1, Template, Features ]
|
|
13
13
|
|
14
14
|
scrollbar: false
|
15
15
|
comments: true
|
16
|
+
fab_menu_id: page_ctrl
|
16
17
|
|
17
18
|
permalink: /pages/public/about/features/
|
18
19
|
regenerate: false
|
19
20
|
|
20
21
|
resources: [ animate, lightbox ]
|
21
22
|
resource_options:
|
23
|
+
|
22
24
|
- attic:
|
25
|
+
padding_top: 550
|
23
26
|
|
24
27
|
slides:
|
25
|
-
- url: /assets/images/modules/attics/
|
26
|
-
alt:
|
27
|
-
|
28
|
-
|
28
|
+
- url: /assets/images/modules/attics/1920x1280/alexander-redl.jpg
|
29
|
+
alt: Photo by Alexander Redl on Unsplash
|
30
|
+
badge:
|
31
|
+
type: unsplash
|
32
|
+
author: Alexander Redl
|
33
|
+
href: https://unsplash.com/@alexanderredl
|
29
34
|
---
|
30
35
|
|
31
36
|
// Page Initializer
|
@@ -18,13 +18,17 @@ permalink: /pages/public/about/reporting_issues/
|
|
18
18
|
|
19
19
|
resources: [ animate ]
|
20
20
|
resource_options:
|
21
|
+
|
21
22
|
- attic:
|
22
|
-
|
23
|
+
padding_top: 550
|
23
24
|
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
25
|
+
slides:
|
26
|
+
- url: /assets/images/modules/attics/1920x1280/alexander-redl.jpg
|
27
|
+
alt: Photo by Alexander Redl on Unsplash
|
28
|
+
badge:
|
29
|
+
type: unsplash
|
30
|
+
author: Alexander Redl
|
31
|
+
href: https://unsplash.com/@alexanderredl
|
28
32
|
---
|
29
33
|
|
30
34
|
// Page Initializer
|
@@ -19,11 +19,17 @@ resources: [ animate ]
|
|
19
19
|
resource_options:
|
20
20
|
- attic:
|
21
21
|
|
22
|
+
padding_top: 550
|
23
|
+
|
22
24
|
slides:
|
23
|
-
- url: /assets/images/modules/attics/
|
24
|
-
alt:
|
25
|
+
- url: /assets/images/modules/attics/1920x1280/alexander-redl.jpg
|
26
|
+
alt: Photo by Alexander Redl on Unsplash
|
25
27
|
title: J1 Template
|
26
28
|
tagline: about
|
29
|
+
badge:
|
30
|
+
type: unsplash
|
31
|
+
author: Alexander Redl
|
32
|
+
href: https://unsplash.com/@alexanderredl
|
27
33
|
---
|
28
34
|
|
29
35
|
// Page Initializer
|
@@ -1,8 +1,8 @@
|
|
1
1
|
---
|
2
2
|
# Top Level Entry Document: 000_intro.asciidoc
|
3
3
|
#
|
4
|
-
title:
|
5
|
-
tagline:
|
4
|
+
title: Skeleton Book
|
5
|
+
tagline: introduction
|
6
6
|
date: 2022-01-01 00:00:00
|
7
7
|
description: >
|
8
8
|
Prawn is a pure Ruby PDF generation library that provides
|
@@ -17,14 +17,16 @@ robots:
|
|
17
17
|
index: false
|
18
18
|
follow: false
|
19
19
|
|
20
|
-
|
21
20
|
permalink: /pages/public/skeleton/documentation/000_intro/
|
22
21
|
regenerate: false
|
23
22
|
|
24
23
|
resources: [ animate, clipboard, lightbox, rouge ]
|
25
24
|
resource_options:
|
25
|
+
|
26
26
|
- attic:
|
27
|
+
|
27
28
|
slides:
|
29
|
+
|
28
30
|
- url: /assets/images/modules/attics/sigmund-1920x1280.jpg
|
29
31
|
alt: Photo by Sigmund on Unsplash
|
30
32
|
alignY: 0.3
|
data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/attributes.asciidoc
CHANGED
@@ -67,13 +67,14 @@ end::footnotes[]
|
|
67
67
|
// Tags - Asciidoc attributes used internally
|
68
68
|
// -----------------------------------------------------------------------------
|
69
69
|
tag::tags[]
|
70
|
-
:images-dir: pages/manuals/asciidoctor_pdf
|
70
|
+
// :images-dir: pages/manuals/asciidoctor_pdf
|
71
71
|
end::tags[]
|
72
72
|
|
73
73
|
|
74
74
|
// Data - Data elements for Asciidoctor extensions
|
75
75
|
// -----------------------------------------------------------------------------
|
76
76
|
tag::data[]
|
77
|
+
:data-images-example--pdf-screenshot: "assets/images/pages/asciidoc_skeletons/example-pdf-screenshot.png, PDF document rendered in a PDF viewer"
|
77
78
|
end::data[]
|
78
79
|
|
79
80
|
|
@@ -21,7 +21,7 @@ Here's an example that demonstrates how to use _Prawn_ to create a basic PDF
|
|
21
21
|
document.
|
22
22
|
|
23
23
|
.Create a basic PDF document using _Prawn_
|
24
|
-
[source,ruby]
|
24
|
+
[source, ruby]
|
25
25
|
----
|
26
26
|
require 'prawn'
|
27
27
|
|
@@ -65,7 +65,10 @@ gems, which we explain how to install in the next section.
|
|
65
65
|
To check if you have _Ruby_ available, use the `ruby` command to query the
|
66
66
|
version installed:
|
67
67
|
|
68
|
-
|
68
|
+
[source, sh]
|
69
|
+
----
|
70
|
+
ruby --version
|
71
|
+
----
|
69
72
|
|
70
73
|
[WARNING]
|
71
74
|
====
|
@@ -77,10 +80,13 @@ Starting with _Prawn_ 2.0.0, _Prawn_ requires Ruby >= 2.0.0 during installation.
|
|
77
80
|
Therefore, to use _Asciidoctor PDF_ with Ruby 1.9.3, you must first explicitly
|
78
81
|
install the following dependencies to lock the versions:
|
79
82
|
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
83
|
+
[source, sh]
|
84
|
+
----
|
85
|
+
gem install prawn --version 1.3.0
|
86
|
+
gem install addressable --version 2.4.0
|
87
|
+
gem install prawn-svg --version 0.21.0
|
88
|
+
gem install prawn-templates --version 0.0.3
|
89
|
+
----
|
84
90
|
|
85
91
|
You can then proceed with installation of _Asciidoctor PDF_ on Ruby 1.9.3.
|
86
92
|
|
@@ -88,12 +94,15 @@ Starting with _Prawn_ 2.2.0, _Prawn_ requires Ruby >= 2.1.0 during installation.
|
|
88
94
|
Therefore, to use _Asciidoctor PDF_ with Ruby 2.0.0, you must first explicitly
|
89
95
|
install the following dependencies to lock the versions:
|
90
96
|
|
91
|
-
|
92
|
-
|
93
|
-
|
97
|
+
[source, sh]
|
98
|
+
----
|
99
|
+
gem install prawn --version 2.1.0
|
100
|
+
gem install prawn-svg --version 0.26.0
|
101
|
+
gem install prawn-templates --version 0.0.4
|
102
|
+
----
|
94
103
|
|
95
|
-
For all other versions of _Ruby_, you can simply install the _Asciidoctor PDF_
|
96
|
-
It will transitively install the required dependencies.
|
104
|
+
For all other versions of _Ruby_, you can simply install the _Asciidoctor PDF_
|
105
|
+
gem. It will transitively install the required dependencies.
|
97
106
|
====
|
98
107
|
|
99
108
|
==== System Encoding
|
@@ -1,32 +1,44 @@
|
|
1
1
|
== Getting Started
|
2
2
|
|
3
|
-
You can get _Asciidoctor PDF_ by installing the published gem or running
|
4
|
-
|
3
|
+
You can get _Asciidoctor PDF_ by installing the published gem or running the
|
4
|
+
code from source.
|
5
5
|
|
6
6
|
=== Install the Published Gem
|
7
7
|
|
8
|
-
_Asciidoctor PDF_ is published as a pre-release on RubyGems.org.
|
9
|
-
|
10
|
-
|
8
|
+
_Asciidoctor PDF_ is published as a pre-release on RubyGems.org. First, make
|
9
|
+
sure you have satisfied the prerequisites. Then, you can install the published
|
10
|
+
gem using the following command:
|
11
11
|
|
12
|
-
|
12
|
+
[source, sh]
|
13
|
+
----
|
14
|
+
gem install asciidoctor-pdf --pre
|
15
|
+
----
|
13
16
|
|
14
17
|
If you want to syntax highlight source listings, you'll also want to install
|
15
18
|
Rouge, Pygments, or CodeRay. Choose one (or more) of the following:
|
16
19
|
|
17
20
|
.Rouge (preferred)
|
18
|
-
|
21
|
+
[source, sh]
|
22
|
+
----
|
23
|
+
gem install rouge
|
24
|
+
----
|
19
25
|
|
20
26
|
.Pygments
|
21
|
-
|
27
|
+
[source, sh]
|
28
|
+
----
|
29
|
+
gem install pygments.rb
|
30
|
+
----
|
22
31
|
|
23
32
|
.CodeRay
|
24
|
-
|
33
|
+
[source, sh]
|
34
|
+
----
|
35
|
+
gem install coderay
|
36
|
+
----
|
25
37
|
|
26
38
|
You then activate syntax highlighting for a given document by adding the
|
27
39
|
`source-highlighter` attribute to the document header (Rouge shown):
|
28
40
|
|
29
|
-
[source,asciidoc]
|
41
|
+
[source, asciidoc]
|
30
42
|
----
|
31
43
|
:source-highlighter: rouge
|
32
44
|
----
|
@@ -34,7 +46,10 @@ You then activate syntax highlighting for a given document by adding the
|
|
34
46
|
Assuming all the required gems install properly, verify you can run the
|
35
47
|
`asciidoctor-pdf` script:
|
36
48
|
|
37
|
-
|
49
|
+
[source, sh]
|
50
|
+
----
|
51
|
+
asciidoctor-pdf -v
|
52
|
+
----
|
38
53
|
|
39
54
|
If you see the version of _Asciidoctor PDF_ printed, you're ready to use
|
40
55
|
_Asciidoctor PDF_.
|
@@ -42,19 +57,51 @@ _Asciidoctor PDF_.
|
|
42
57
|
Let's grab an AsciiDoc document to distill and start putting _Asciidoctor PDF_
|
43
58
|
to use!
|
44
59
|
|
45
|
-
=== An
|
60
|
+
=== An example AsciiDoc document
|
46
61
|
|
47
62
|
If you don't already have an AsciiDoc document, you can use the
|
48
63
|
*basic_example.adoc* file found in the examples directory of this
|
49
64
|
project.
|
50
65
|
|
66
|
+
/////
|
51
67
|
ifeval::[{safe-mode-level} < 20]
|
52
68
|
.000_basic_example.adoc
|
53
|
-
[source,asciidoc]
|
54
|
-
|
55
|
-
|
56
|
-
|
69
|
+
[source, asciidoc]
|
70
|
+
----
|
71
|
+
= Document Title
|
72
|
+
|
73
|
+
Doc Writer <doc@example.com>
|
74
|
+
:doctype: book
|
75
|
+
:reproducible:
|
76
|
+
//:source-highlighter: coderay
|
77
|
+
:source-highlighter: rouge
|
78
|
+
:listing-caption: Listing
|
79
|
+
// Uncomment next line to set page size (default is A4)
|
80
|
+
//:pdf-page-size: Letter
|
81
|
+
|
82
|
+
A simple http://asciidoc.org[AsciiDoc] document.
|
83
|
+
|
84
|
+
== Introduction
|
85
|
+
|
86
|
+
A paragraph followed by a simple list with square bullets.
|
87
|
+
|
88
|
+
[square]
|
89
|
+
* item 1
|
90
|
+
* item 2
|
91
|
+
|
92
|
+
Here's how you say "`Hello, World!`" in Prawn:
|
93
|
+
|
94
|
+
.Create a basic PDF document using Prawn
|
95
|
+
[source,ruby]
|
96
|
+
----
|
97
|
+
require 'prawn'
|
98
|
+
|
99
|
+
Prawn::Document.generate 'example.pdf' do
|
100
|
+
text 'Hello, World!'
|
101
|
+
end
|
102
|
+
----
|
57
103
|
endif::[]
|
104
|
+
/////
|
58
105
|
|
59
106
|
It's time to convert the AsciiDoc document directly to PDF.
|
60
107
|
|
@@ -66,11 +113,17 @@ it uses the `source-highlighter` attribute with the value of `rouge`.
|
|
66
113
|
Converting to PDF is a simple as running the `asciidoctor-pdf` script using
|
67
114
|
_Ruby_ and passing our AsciiDoc document as the first argument.
|
68
115
|
|
69
|
-
|
116
|
+
[source, sh]
|
117
|
+
----
|
118
|
+
asciidoctor-pdf 000_basic_example.adoc
|
119
|
+
----
|
70
120
|
|
71
|
-
This command is just a shorthand way of running:
|
121
|
+
This command is just a *shorthand* way of running:
|
72
122
|
|
73
|
-
|
123
|
+
[source, sh]
|
124
|
+
----
|
125
|
+
asciidoctor -r asciidoctor-pdf -b pdf 000_basic_example.adoc
|
126
|
+
----
|
74
127
|
|
75
128
|
The `asciidoctor-pdf` command just saves you from having to remember all those
|
76
129
|
flags. That's why we created it.
|
@@ -81,15 +134,14 @@ viewer to see the result.
|
|
81
134
|
|
82
135
|
ifdef::backend-html5[]
|
83
136
|
.Example PDF document rendered in a PDF viewer
|
84
|
-
|
137
|
+
lightbox::images-example--pdf-screenshot[ 1024, {data-images-example--pdf-screenshot}, role="mb-4" ]
|
85
138
|
endif::[]
|
86
139
|
|
87
140
|
ifdef::backend-pdf[]
|
88
141
|
.Example PDF document rendered in a PDF viewer
|
89
|
-
image::/assets/images/pages/asciidoc_skeletons/example-pdf-screenshot.png[
|
142
|
+
image::/assets/images/pages/asciidoc_skeletons/example-pdf-screenshot.png[PDF document rendered in a PDF viewer, width=800, scaledwidth=100%]
|
90
143
|
endif::[]
|
91
144
|
|
92
145
|
You're also encouraged to try converting the documents in the examples
|
93
|
-
directory to see more of what _Asciidoctor PDF_ can do.
|
94
|
-
|
95
|
-
The pain of the DocBook toolchain should be melting away about now.
|
146
|
+
directory to see more of what _Asciidoctor PDF_ can do. The pain of the
|
147
|
+
DocBook toolchain should be melting away from now.
|