rbcli 0.2.12 → 0.3.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 (113) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +15 -0
  3. data/Gemfile.lock +39 -38
  4. data/docs-src/content/development/changelog.md +16 -1
  5. data/docs-src/themes/hugo-theme-learn/CHANGELOG.md +74 -2
  6. data/docs-src/themes/hugo-theme-learn/README.md +42 -5
  7. data/docs-src/themes/hugo-theme-learn/exampleSite/config.toml +27 -0
  8. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.zh.md +12 -0
  9. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.en.md +6 -4
  10. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.fr.md +7 -5
  11. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.en.md +1 -1
  12. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/markdown.en.md +88 -61
  13. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/_index.fr.md +3 -3
  14. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/syntaxhighlight.en.md +89 -0
  15. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.en.md +2 -2
  16. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/notice.en.md +2 -2
  17. data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.en.md +4 -1
  18. data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.fr.md +4 -1
  19. data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.svg +1 -237
  20. data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/inteliver_docs.png +0 -0
  21. data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/tshark_dev.png +0 -0
  22. data/docs-src/themes/hugo-theme-learn/i18n/ar.toml +26 -0
  23. data/docs-src/themes/hugo-theme-learn/i18n/de.toml +26 -0
  24. data/docs-src/themes/hugo-theme-learn/i18n/hi.toml +26 -0
  25. data/docs-src/themes/hugo-theme-learn/i18n/ja.toml +26 -0
  26. data/docs-src/themes/hugo-theme-learn/i18n/ru.toml +26 -0
  27. data/docs-src/themes/hugo-theme-learn/i18n/zh-cn.toml +26 -0
  28. data/docs-src/themes/hugo-theme-learn/layouts/_default/list.html +1 -1
  29. data/docs-src/themes/hugo-theme-learn/layouts/_default/single.html +1 -2
  30. data/docs-src/themes/hugo-theme-learn/layouts/partials/footer.html +3 -4
  31. data/docs-src/themes/hugo-theme-learn/layouts/partials/header.html +8 -6
  32. data/docs-src/themes/hugo-theme-learn/layouts/partials/menu.html +6 -5
  33. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/children.html +2 -2
  34. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/ref.html +1 -1
  35. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/relref.html +1 -1
  36. data/docs-src/themes/hugo-theme-learn/netlify.toml +1 -2
  37. data/docs-src/themes/hugo-theme-learn/static/css/theme.css +4 -0
  38. data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.svg +1 -359
  39. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.svg +1 -1019
  40. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.svg +1 -918
  41. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.svg +1 -332
  42. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.svg +1 -331
  43. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.svg +1 -333
  44. data/docs-src/themes/hugo-theme-learn/static/images/clippy.svg +1 -1
  45. data/docs-src/themes/hugo-theme-learn/static/js/auto-complete.js +3 -223
  46. data/docs-src/themes/hugo-theme-learn/static/js/highlight.pack.js +6 -3
  47. data/docs-src/themes/hugo-theme-learn/static/js/hugo-learn.js +8 -5
  48. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.svg +1 -1260
  49. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.svg +1 -471
  50. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.svg +1 -2763
  51. data/docs/404.html +8 -8
  52. data/docs/advanced/automatic_updates/index.html +85 -65
  53. data/docs/advanced/command_types/index.html +139 -144
  54. data/docs/advanced/distributed_state_locking/index.html +83 -55
  55. data/docs/advanced/hooks/index.html +94 -81
  56. data/docs/advanced/index.html +75 -34
  57. data/docs/advanced/index.xml +8 -8
  58. data/docs/advanced/interactive_commands/index.html +90 -66
  59. data/docs/advanced/logging/index.html +94 -67
  60. data/docs/advanced/remote_execution/index.html +94 -75
  61. data/docs/advanced/state_storage/index.html +122 -119
  62. data/docs/advanced/user_config_files/index.html +94 -71
  63. data/docs/categories/index.html +82 -30
  64. data/docs/categories/index.xml +1 -1
  65. data/docs/css/theme.css +4 -0
  66. data/docs/development/changelog/index.html +185 -177
  67. data/docs/development/code_of_conduct/index.html +85 -64
  68. data/docs/development/contributing/index.html +96 -96
  69. data/docs/development/index.html +75 -34
  70. data/docs/development/index.xml +2 -2
  71. data/docs/development/license/index.html +80 -46
  72. data/docs/fonts/Inconsolata.svg +1 -359
  73. data/docs/fonts/Novecentosanswide-Normal-webfont.svg +1 -1019
  74. data/docs/fonts/Novecentosanswide-UltraLight-webfont.svg +1 -918
  75. data/docs/fonts/Work_Sans_200.svg +1 -332
  76. data/docs/fonts/Work_Sans_300.svg +1 -331
  77. data/docs/fonts/Work_Sans_500.svg +1 -333
  78. data/docs/images/clippy.svg +1 -1
  79. data/docs/index.html +112 -61
  80. data/docs/index.json +24 -24
  81. data/docs/index.xml +13 -13
  82. data/docs/js/auto-complete.js +3 -223
  83. data/docs/js/highlight.pack.js +6 -3
  84. data/docs/js/hugo-learn.js +8 -5
  85. data/docs/quick_reference/index.html +126 -159
  86. data/docs/quick_reference/index.xml +1 -1
  87. data/docs/sitemap.xml +2 -4
  88. data/docs/tags/index.html +82 -30
  89. data/docs/tags/index.xml +1 -1
  90. data/docs/tutorial/10-getting_started/index.html +87 -66
  91. data/docs/tutorial/20-project_layout/index.html +126 -116
  92. data/docs/tutorial/30-your_first_command/index.html +151 -141
  93. data/docs/tutorial/40-options_parameters_and_arguments/index.html +233 -258
  94. data/docs/tutorial/50-publishing/index.html +86 -66
  95. data/docs/tutorial/index.html +75 -34
  96. data/docs/tutorial/index.xml +4 -4
  97. data/docs/webfonts/fa-brands-400.svg +1 -1260
  98. data/docs/webfonts/fa-regular-400.svg +1 -471
  99. data/docs/webfonts/fa-solid-900.svg +1 -2763
  100. data/docs/whoami/index.html +76 -46
  101. data/docs/whoami/index.xml +1 -1
  102. data/lib/rbcli/configuration/configurate_blocks/me.rb +5 -5
  103. data/lib/rbcli/util/deprecation_warning.rb +21 -4
  104. data/lib/rbcli/version.rb +1 -1
  105. data/rbcli.gemspec +8 -8
  106. data/skeletons/project/Gemfile +1 -1
  107. data/skeletons/project/config/general.rb +1 -1
  108. data/skeletons/project/lib/lib.erb +2 -0
  109. data/skeletons/project/spec/spec_helper.rb +7 -7
  110. data/skeletons/project/spec/untitled_spec.rb +6 -6
  111. data/skeletons/project/untitled.gemspec +28 -26
  112. metadata +29 -20
  113. data/docs-src/themes/hugo-theme-learn/static/js/html5shiv-printshiv.min.js +0 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e3401b5ab4b10b016f2e498d85c90e4a8d3b59c39d82530bbca8407e94f9651d
4
- data.tar.gz: ca1bba7007a6f72c00f029e0532a0eade7d7320e2325ea7737bf0581218a16be
3
+ metadata.gz: 558f89fc85c5ce81beadc393101cee8e2af7cefb082bb0af255a60d33a58dd3e
4
+ data.tar.gz: 8d19d26b6ee7612cef2d5f2e4e8f8d47b509dc759fc759091606b7d71bd56f66
5
5
  SHA512:
6
- metadata.gz: 530d499ab60cc314011c9d3e388ba6935436fd4d03e5a890dfda46d66b6eb22ef1a56e687722d074a3667b746ccce9cfca4e3b66c32d790c100b8bf7625f0bc6
7
- data.tar.gz: e646edaf706fa0602b954c567704d721c28e9bbd4de69daac984170309860501a65f61adbc82ab856d667dfb208570732a7a5eacb7c81f30795ad84d689134fd
6
+ metadata.gz: 4ab7a72246f3567a2661860e0e76340336cdb53842e340cd5bfd5571d6f30a5a1fad684882a7d0a53c0629c7a1c811aff6387a84d2420fa874b6e9eac8efd9e6
7
+ data.tar.gz: 765ada196994fe2bea223598ca9b84ef38aeee567937c29b003c5118102aaf7227f04e14b8fc2c406c037440eba1c292f284474836b02161ec776aef456bde32
@@ -1,5 +1,20 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.3 (July 31, 2020)
4
+
5
+ ### Improvements
6
+
7
+ * Deprecated Ruby code has been updated to be compatible with Ruby 2.7.x
8
+ * All depedencies have been updated to their latest versions and tested to ensure continued compatibility
9
+ * Old-style execution hooks have been fully deprecated in favor of declaring them in the `Rbcli::Configurate.hooks` block. To ensure compatibility, save your current hooks and generate new ones using the command `rbcli hook`
10
+ * Skeleton gemspec now includes `spec.required_ruby_version`, which matches Rbcli's requirement
11
+ * Documentation updated to support latest Hugo and theme versions (Hugo 0.74.3 and hugo-theme-learn 2.5.0)
12
+
13
+ ### Features
14
+
15
+ * Rbcli Deprecation Warnings now show the offending line of code to ease updating
16
+ * The `$libdir` global variable is defined by default in the skeleton project, allwoing easy access to the project's `lib` folder
17
+
3
18
  ## 0.2.12 (July 29, 2019)
4
19
 
5
20
  ### Improvements
@@ -1,73 +1,74 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- rbcli (0.2.12)
5
- aws-sdk-dynamodb (~> 1.21)
4
+ rbcli (0.3.0)
5
+ aws-sdk-dynamodb (~> 1.51)
6
6
  colorize (~> 0.8)
7
7
  deep_merge (~> 1.2)
8
8
  macaddr (~> 1.7)
9
- mdless (~> 0.0)
10
- net-scp (~> 1.2)
11
- net-ssh (~> 5.1)
12
- octokit (~> 4.13)
13
- rufus-scheduler (~> 3.5)
9
+ mdless (~> 1.0)
10
+ net-scp (~> 3.0)
11
+ net-ssh (~> 6.1)
12
+ octokit (~> 4.18)
13
+ rufus-scheduler (~> 3.6)
14
14
 
15
15
  GEM
16
16
  remote: https://rubygems.org/
17
17
  specs:
18
- addressable (2.6.0)
19
- public_suffix (>= 2.0.2, < 4.0)
20
- aws-eventstream (1.0.3)
21
- aws-partitions (1.161.0)
22
- aws-sdk-core (3.51.0)
23
- aws-eventstream (~> 1.0, >= 1.0.2)
24
- aws-partitions (~> 1.0)
18
+ addressable (2.7.0)
19
+ public_suffix (>= 2.0.2, < 5.0)
20
+ aws-eventstream (1.1.0)
21
+ aws-partitions (1.348.0)
22
+ aws-sdk-core (3.104.3)
23
+ aws-eventstream (~> 1, >= 1.0.2)
24
+ aws-partitions (~> 1, >= 1.239.0)
25
25
  aws-sigv4 (~> 1.1)
26
26
  jmespath (~> 1.0)
27
- aws-sdk-dynamodb (1.26.0)
28
- aws-sdk-core (~> 3, >= 3.48.2)
27
+ aws-sdk-dynamodb (1.51.0)
28
+ aws-sdk-core (~> 3, >= 3.99.0)
29
29
  aws-sigv4 (~> 1.1)
30
- aws-sigv4 (1.1.0)
31
- aws-eventstream (~> 1.0, >= 1.0.2)
30
+ aws-sigv4 (1.2.1)
31
+ aws-eventstream (~> 1, >= 1.0.2)
32
32
  colorize (0.8.1)
33
- concurrent-ruby (1.1.5)
34
33
  deep_merge (1.2.1)
35
- et-orbi (1.2.1)
34
+ et-orbi (1.2.4)
36
35
  tzinfo
37
- faraday (0.15.4)
36
+ faraday (1.0.1)
38
37
  multipart-post (>= 1.2, < 3)
39
- fugit (1.2.1)
38
+ fugit (1.3.6)
40
39
  et-orbi (~> 1.1, >= 1.1.8)
41
- raabro (~> 1.1)
40
+ raabro (~> 1.3)
42
41
  jmespath (1.4.0)
43
- macaddr (1.7.1)
44
- systemu (~> 2.6.2)
45
- mdless (0.0.10)
42
+ macaddr (1.7.2)
43
+ systemu (~> 2.6.5)
44
+ mdless (1.0.14)
46
45
  multipart-post (2.1.1)
47
- net-scp (1.2.1)
48
- net-ssh (>= 2.6.5)
49
- net-ssh (5.2.0)
50
- octokit (4.14.0)
46
+ net-scp (3.0.0)
47
+ net-ssh (>= 2.6.5, < 7.0.0)
48
+ net-ssh (6.1.0)
49
+ octokit (4.18.0)
50
+ faraday (>= 0.9)
51
51
  sawyer (~> 0.8.0, >= 0.5.3)
52
- public_suffix (3.1.1)
53
- raabro (1.1.6)
54
- rake (12.3.2)
52
+ public_suffix (4.0.5)
53
+ raabro (1.3.1)
54
+ rake (13.0.1)
55
55
  rufus-scheduler (3.6.0)
56
56
  fugit (~> 1.1, >= 1.1.6)
57
57
  sawyer (0.8.2)
58
58
  addressable (>= 2.3.5)
59
59
  faraday (> 0.8, < 2.0)
60
60
  systemu (2.6.5)
61
- tzinfo (2.0.0)
62
- concurrent-ruby (~> 1.0)
61
+ thread_safe (0.3.6)
62
+ tzinfo (1.2.7)
63
+ thread_safe (~> 0.1)
63
64
 
64
65
  PLATFORMS
65
66
  ruby
66
67
 
67
68
  DEPENDENCIES
68
- bundler (~> 2.0)
69
- rake (~> 12.3)
69
+ bundler (~> 2.1)
70
+ rake (~> 13.0)
70
71
  rbcli!
71
72
 
72
73
  BUNDLED WITH
73
- 2.0.1
74
+ 2.1.4
@@ -6,7 +6,22 @@ weight: 100
6
6
  ---
7
7
 
8
8
 
9
- ## 0.2.12 (Unreleased)
9
+ ## 0.3 (July 31, 2020)
10
+
11
+ ### Improvements
12
+
13
+ * Deprecated Ruby code has been updated to be compatible with Ruby 2.7.x
14
+ * All depedencies have been updated to their latest versions and tested to ensure continued compatibility
15
+ * Old-style execution hooks have been fully deprecated in favor of declaring them in the `Rbcli::Configurate.hooks` block. To ensure compatibility, save your current hooks and generate new ones using the command `rbcli hook`
16
+ * Skeleton gemspec now includes `spec.required_ruby_version`, which matches Rbcli's requirement
17
+ * Documentation updated to support latest Hugo and theme versions (Hugo 0.74.3 and hugo-theme-learn 2.5.0)
18
+
19
+ ### Features
20
+
21
+ * Rbcli Deprecation Warnings now show the offending line of code to ease updating
22
+ * The `$libdir` global variable is defined by default in the skeleton project, allwoing easy access to the project's `lib` folder
23
+
24
+ ## 0.2.12 (July 29, 2019)
10
25
 
11
26
  ### Improvements
12
27
 
@@ -1,5 +1,76 @@
1
1
  # Changelog
2
2
 
3
+ ## v2.5.0 (01/06/2020)
4
+
5
+ #### New features
6
+
7
+ - [**feature**] Allow custom css files to be loaded by configuration [#376](https://github.com/matcornic/hugo-theme-learn/pull/376)
8
+ - [**feature**] Added flag to turn off image featherlight [#333](https://github.com/matcornic/hugo-theme-learn/pull/333)
9
+
10
+ #### Bug Fixes
11
+
12
+ - [**bug**] fix null pointer when no params on image url [#383](https://github.com/matcornic/hugo-theme-learn/pull/383)
13
+ - [**bug**] can't give argument to non-function not .Params.hidden [#403](https://github.com/matcornic/hugo-theme-learn/pull/403)
14
+ - [**bug**] Fix .File.UniqueID on zero object warning [#372](https://github.com/matcornic/hugo-theme-learn/pull/372)
15
+ - [**bug**] fix select option color in Chrome [#345](https://github.com/matcornic/hugo-theme-learn/pull/345)
16
+ - [**bug**] remove unneeded spaces from HTML [#320](https://github.com/matcornic/hugo-theme-learn/pull/320)
17
+ - [**bug**] Avoid displaying hidden sections in menu [#354](https://github.com/matcornic/hugo-theme-learn/pull/354)
18
+
19
+ #### Enhancements
20
+
21
+ - [**enhancement**] Updated theme installation documentation link. [#390](https://github.com/matcornic/hugo-theme-learn/pull/390)
22
+ - [**enhancement**] [ImgBot] Optimize images [#366](https://github.com/matcornic/hugo-theme-learn/pull/366)
23
+ - [**enhancement**] fix extra spaces in the description [#339](https://github.com/matcornic/hugo-theme-learn/pull/339)
24
+ - [**enhancement**] change to minified 'autocomplete.js' for improved performance [#321](https://github.com/matcornic/hugo-theme-learn/pull/321)
25
+
26
+ #### Internationalisation
27
+
28
+ - [**i18n**] Fix: typos [#343](https://github.com/matcornic/hugo-theme-learn/pull/343)
29
+ - [**i18n**] Fix: typo [#342](https://github.com/matcornic/hugo-theme-learn/pull/342)
30
+ - [**i18n**] Incorrect english in notice documentation [#336](https://github.com/matcornic/hugo-theme-learn/pull/336)
31
+ - [**i18n**] Add Chinese language for this theme [#349](https://github.com/matcornic/hugo-theme-learn/pull/349)
32
+ - [**i18n**] Add jp and zh cn [#335](https://github.com/matcornic/hugo-theme-learn/pull/335)
33
+ - [**i18n**] Added Russian translation [#332](https://github.com/matcornic/hugo-theme-learn/pull/332)
34
+
35
+ #### Theme Meta
36
+
37
+ - [**meta**] Fix various linting warnings [#405](https://github.com/matcornic/hugo-theme-learn/pull/405)
38
+ - [**meta**] Netlify build on 0.66.0 [#377](https://github.com/matcornic/hugo-theme-learn/pull/377)
39
+ - [**meta**] add inteliver documentation showcase [#331](https://github.com/matcornic/hugo-theme-learn/pull/331)
40
+
41
+ ---
42
+
43
+ ## v2.4.0 (04/09/2019)
44
+
45
+ #### Bug Fixes
46
+
47
+ - [**bug**] correct GitHub capitalization [#293](https://github.com/matcornic/hugo-theme-learn/pull/293)
48
+ - [**bug**] fix 'locate' typo [#285](https://github.com/matcornic/hugo-theme-learn/pull/285)
49
+ - [**bug**] Remove reference to the unused horsey CSS [#284](https://github.com/matcornic/hugo-theme-learn/pull/284)
50
+ - [**bug**] Fix invalid HTML in 404 template. [#271](https://github.com/matcornic/hugo-theme-learn/pull/271)
51
+
52
+ #### Enhancements
53
+
54
+ - [**enhancement**] Delete html5shiv-printshiv.min.js [#319](https://github.com/matcornic/hugo-theme-learn/pull/319)
55
+ - [**enhancement**] remove html5shiv [#315](https://github.com/matcornic/hugo-theme-learn/pull/315)
56
+ - [**enhancement**] Fix deprecated .Hugo, .UniqueID and .URL references [#303](https://github.com/matcornic/hugo-theme-learn/pull/303)
57
+ - [**enhancement**] Fix type lines 364 and 369 [#304](https://github.com/matcornic/hugo-theme-learn/pull/304)
58
+ - [**enhancement**] remove unneeded type="text/css" [#298](https://github.com/matcornic/hugo-theme-learn/pull/298)
59
+ - [**enhancement**] remove unneeded type="text/css" [#297](https://github.com/matcornic/hugo-theme-learn/pull/297)
60
+ - [**enhancement**] HTTPS links in footer [#295](https://github.com/matcornic/hugo-theme-learn/pull/295)
61
+ - [**enhancement**] remove unneeded type="text/css" [#292](https://github.com/matcornic/hugo-theme-learn/pull/292)
62
+ - [**enhancement**] Make shortcodes & example site compatible with Hugo v0.55 [#281](https://github.com/matcornic/hugo-theme-learn/pull/281)
63
+
64
+ #### Internationalisation
65
+
66
+ - [**i18n**] Added German and Arabic translation [#312](https://github.com/matcornic/hugo-theme-learn/pull/312)
67
+
68
+ #### Theme Meta
69
+
70
+ - [**meta**] Added Tshark.dev as example site [#318](https://github.com/matcornic/hugo-theme-learn/pull/318)
71
+
72
+ ---
73
+
3
74
  ## v2.3.0 (16/04/2019)
4
75
 
5
76
  #### New features
@@ -15,10 +86,11 @@
15
86
 
16
87
  #### Enhancements
17
88
 
89
+ - [**enhancement**] Render the ```mermaid blocks into graphs [#226](https://github.com/matcornic/hugo-theme-learn/pull/226)
90
+ - [**enhancement**] Remove oudated versions of jquery & modernizr libraries [#259](https://github.com/matcornic/hugo-theme-learn/pull/259)
18
91
  - [**enhancement**] Various Updates [#237](https://github.com/matcornic/hugo-theme-learn/pull/237)
19
92
  - [**enhancement**] Use style instead of width and height in logo [#250](https://github.com/matcornic/hugo-theme-learn/pull/250)
20
93
  - [**enhancement**] [ImgBot] Optimize images [#222](https://github.com/matcornic/hugo-theme-learn/pull/222)
21
- - [**enhancement**] Render the ```mermaid blocks into graphs [#226](https://github.com/matcornic/hugo-theme-learn/pull/226)
22
94
  - [**enhancement**] remove duplicate icon and fix incorrect favicon type [#227](https://github.com/matcornic/hugo-theme-learn/pull/227)
23
95
  - [**enhancement**] HTTPS links in exampleSite menu-footer [#223](https://github.com/matcornic/hugo-theme-learn/pull/223)
24
96
 
@@ -147,7 +219,7 @@
147
219
  - [**closed**] feat: style Hugo figure shortcode [#33](https://github.com/matcornic/hugo-theme-learn/pull/33)
148
220
  - [**closed**] Fix URL for 'Edit this page' on Windows [#27](https://github.com/matcornic/hugo-theme-learn/pull/27)
149
221
  - [**closed**] Revert "Menu generation using Content file instead directories" [#10](https://github.com/matcornic/hugo-theme-learn/pull/10)
150
- - [**closed**] (#25) use .Site.BaseURL to locate static assets [#26](https://github.com/matcornic/hugo-theme-learn/pull/26)
222
+ - [**closed**] (#25) use .Site.BaseURL to lcoate static assets [#26](https://github.com/matcornic/hugo-theme-learn/pull/26)
151
223
  - [**closed**] Menu ordering and definition in config.toml [#8](https://github.com/matcornic/hugo-theme-learn/pull/8)
152
224
  - [**closed**] Menu generation using Content file instead directories [#5](https://github.com/matcornic/hugo-theme-learn/pull/5)
153
225
  - [**closed**] Add Checkmark On visited Links [#4](https://github.com/matcornic/hugo-theme-learn/pull/4)
@@ -24,9 +24,9 @@ Visit the [theme documentation](https://learn.netlify.com/en/) to see what is go
24
24
 
25
25
  Navigate to your themes folder in your Hugo site and use the following commands:
26
26
 
27
- ```
28
- $ cd themes
29
- $ git clone https://github.com/matcornic/hugo-theme-learn.git
27
+ ```shell
28
+ cd themes/
29
+ git clone https://github.com/matcornic/hugo-theme-learn.git
30
30
  ```
31
31
 
32
32
  Check that your Hugo version is minimum `0.25` with `hugo version`.
@@ -39,7 +39,7 @@ Check that your Hugo version is minimum `0.25` with `hugo version`.
39
39
 
40
40
  ## Download old versions (prior to 2.0.0)
41
41
 
42
- If you need old version for compatibility purpose, either download [theme source code from releases](https://github.com/matcornic/hugo-theme-learn/releases) or use the right git tag. For example, with `1.1.0`
42
+ If you need old version for compatibility purpose, either download [theme source code from releases](https://github.com/matcornic/hugo-theme-learn/releases) or use the right git tag. For example, with `1.1.0`
43
43
 
44
44
  - Direct download way: https://github.com/matcornic/hugo-theme-learn/archive/1.1.0.zip
45
45
  - Git way:
@@ -55,6 +55,43 @@ For both solutions, the documentation is available at https://github.com/matcorn
55
55
 
56
56
  Many thanks to [@vjeantet](https://github.com/vjeantet/) for the fork [docdock](https://github.com/vjeantet/hugo-theme-docdock). The v2 of this theme is mainly based on his work !
57
57
 
58
-
59
58
  ## License
59
+
60
60
  [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_large)
61
+
62
+ ## Releasing
63
+
64
+ Somewhat work-in-progress steps to release with [gren](https://github.com/github-tools/github-release-notes)
65
+
66
+ - Check all MRs assigned to the milestone are closed or pushed back to another release
67
+ - Close the milestone
68
+ - Check merged MRs on the milestone have a tag (Bug, Enhancement, etc.)
69
+ - Tag and push the repo
70
+
71
+ ```shell
72
+ git tag <tag>
73
+ git push origin <tag>
74
+ ```
75
+
76
+ - Generate CHANGELOG.md with _gren_
77
+
78
+ ```shell
79
+ gren changelog --override --generate --tags=all
80
+ ```
81
+
82
+ - Fix the date for the current release in CHANGELOG.md
83
+ - Add the changelog to git and update the tag
84
+
85
+ ```shell
86
+ git add CHANGELOG.md
87
+ git commit -m "Ship tag <tag>"
88
+ git push origin master
89
+ git tag -f <tag>
90
+ git push --force origin <tag>
91
+ ```
92
+
93
+ - Generate release with _gren_
94
+
95
+ ```shell
96
+ gren release -t <tag>
97
+ ```
@@ -73,3 +73,30 @@ weight = 20
73
73
  name = "<i class='fas fa-fw fa-bullhorn'></i> Crédits"
74
74
  url = "/credits"
75
75
  weight = 30
76
+
77
+ [Languages.zh]
78
+ title = "Hugo 主题的 Learn 文档"
79
+ weight = 3
80
+ languageName = "简体中文"
81
+
82
+ [[Languages.zh.menu.shortcuts]]
83
+ name = "<i class='fab fa-fw fa-github'></i> GitHub 仓库"
84
+ identifier = "ds"
85
+ url = "https://github.com/matcornic/hugo-theme-learn"
86
+ weight = 10
87
+
88
+ [[Languages.zh.menu.shortcuts]]
89
+ name = "<i class='fas fa-fw fa-camera'></i> 展示区"
90
+ url = "/showcase"
91
+ weight = 11
92
+
93
+ [[Languages.zh.menu.shortcuts]]
94
+ name = "<i class='fas fa-fw fa-bookmark'></i> Hugo 文档"
95
+ identifier = "hugodoc"
96
+ url = "https://gohugo.io/"
97
+ weight = 20
98
+
99
+ [[Languages.zh.menu.shortcuts]]
100
+ name = "<i class='fas fa-fw fa-bullhorn'></i> 鸣谢"
101
+ url = "/credits"
102
+ weight = 30
@@ -0,0 +1,12 @@
1
+ ---
2
+ title: 基础
3
+ weight: 5
4
+ pre: "<b>1. </b>"
5
+ chapter: true
6
+ ---
7
+
8
+ ### 章节 1
9
+
10
+ # 基础
11
+
12
+ 了解该 Hugo 主题的特点以及背后的核心概念。
@@ -12,7 +12,7 @@ Note that some of these parameters are explained in details in other sections of
12
12
 
13
13
  ```toml
14
14
  [params]
15
- # Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page.
15
+ # Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page.
16
16
  # Useful to give opportunity to people to create merge request for your doc.
17
17
  # See the config.toml file from this documentation site to have an example.
18
18
  editURL = ""
@@ -24,12 +24,12 @@ Note that some of these parameters are explained in details in other sections of
24
24
  showVisitedLinks = false
25
25
  # Disable search function. It will hide search bar
26
26
  disableSearch = false
27
- # Javascript and CSS cache are automatically busted when new version of site is generated.
27
+ # Javascript and CSS cache are automatically busted when new version of site is generated.
28
28
  # Set this to true to disable this behavior (some proxies don't handle well this optimization)
29
29
  disableAssetsBusting = false
30
30
  # Set this to true to disable copy-to-clipboard button for inline code.
31
31
  disableInlineCopyToClipBoard = false
32
- # A title for shortcuts in menu is set by default. Set this to true to disable it.
32
+ # A title for shortcuts in menu is set by default. Set this to true to disable it.
33
33
  disableShortcutsTitle = false
34
34
  # When using mulitlingual website, disable the switch language button.
35
35
  disableLanguageSwitchingButton = false
@@ -41,6 +41,8 @@ Note that some of these parameters are explained in details in other sections of
41
41
  ordersectionsby = "weight"
42
42
  # Change default color scheme with a variant one. Can be "red", "blue", "green".
43
43
  themeVariant = ""
44
+ # Provide a list of custom css files to load relative from the `static/` folder in the site root.
45
+ custom_css = ["css/foo.css", "css/bar.css"]
44
46
  ```
45
47
 
46
48
  ## Activate search
@@ -54,5 +56,5 @@ home = [ "HTML", "RSS", "JSON"]
54
56
 
55
57
  Learn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.
56
58
 
57
- > Hugo generate lunrjs index.json at the root of public folder.
59
+ > Hugo generate lunrjs index.json at the root of public folder.
58
60
  > When you build the site with `hugo server`, hugo generates it internally and of course it doesn’t show up in the filesystem
@@ -24,12 +24,12 @@ Notez que certains de ces paramètres sont expliqués en détails dans d'autres
24
24
  showVisitedLinks = false
25
25
  # Désactive la fonction de recherche. Une valeur à true cache la barre de recherche.
26
26
  disableSearch = false
27
- # Par défaut, le cache Javascript et CSS est automatiquement vidé lorsqu'une nouvelle version du site est générée.
27
+ # Par défaut, le cache Javascript et CSS est automatiquement vidé lorsqu'une nouvelle version du site est générée.
28
28
  # Utilisez ce paramètre lorsque vous voulez désactiver ce comportement (c'est parfois incompatible avec certains proxys)
29
29
  disableAssetsBusting = false
30
30
  # Utilisez ce paramètre pour désactiver le bouton copy-to-clipboard pour le code formatté sur une ligne.
31
31
  disableInlineCopyToClipBoard = false
32
- # Un titre est défini par défaut lorsque vous utilisez un raccourci dans le menu. Utilisez ce paramètre pour le cacher.
32
+ # Un titre est défini par défaut lorsque vous utilisez un raccourci dans le menu. Utilisez ce paramètre pour le cacher.
33
33
  disableShortcutsTitle = false
34
34
  # Quand vous utilisez un site multi-langue, utilisez ce paramètre pour désactiver le bouton de changement de langue.
35
35
  disableLanguageSwitchingButton = false
@@ -37,6 +37,8 @@ Notez que certains de ces paramètres sont expliqués en détails dans d'autres
37
37
  ordersectionsby = "weight"
38
38
  # Utilisez ce paramètre pour modifier le schéma de couleur du site. Les valeurs par défaut sont "red", "blue", "green".
39
39
  themeVariant = ""
40
+ # Fournissez une liste de fichiers css personnalisés à charger par rapport depuis le dossier `static/` à la racine du site.
41
+ custom_css = ["css/foo.css", "css/bar.css"]
40
42
  ```
41
43
 
42
44
  ## Activer la recherche {#activer-recherche}
@@ -48,7 +50,7 @@ Si ce n'est pas déjà présent, ajoutez les lignes suivantes dans le fichier `c
48
50
  home = [ "HTML", "RSS", "JSON"]
49
51
  ```
50
52
 
51
- Le thème *Learn* utilise les dernières amélioraions d'Hugo pour générer un fichier d'index JSON, prêt à être consommé par le moteur de recherche lunr.js.
53
+ Le thème *Learn* utilise les dernières améliorations d'Hugo pour générer un fichier d'index JSON, prêt à être consommé par le moteur de recherche lunr.js.
52
54
 
53
- > Hugo génère lunrjs index.json à la racine du dossier `public`.
54
- > Quand vous générez le site avec `hugo server`, Hugo génère le fichier en mémoire, il n'est donc pas disponible sur le disque.
55
+ > Hugo génère lunrjs index.json à la racine du dossier `public`.
56
+ > Quand vous générez le site avec `hugo server`, Hugo génère le fichier en mémoire, il n'est donc pas disponible sur le disque.