docula 0.3.7 → 0.4.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 (181) hide show
  1. package/README.md +108 -39
  2. package/bin/docula.mjs +8 -0
  3. package/dist/builder.d.ts +34 -0
  4. package/dist/builder.js +182 -0
  5. package/dist/console.d.ts +22 -0
  6. package/dist/console.js +120 -0
  7. package/dist/docula.d.ts +22 -22
  8. package/dist/docula.js +125 -174
  9. package/dist/github.d.ts +22 -0
  10. package/dist/github.js +74 -0
  11. package/dist/helpers/markdown.d.ts +10 -0
  12. package/dist/helpers/markdown.js +24 -0
  13. package/dist/helpers.d.ts +7 -0
  14. package/dist/helpers.js +58 -0
  15. package/dist/options.d.ts +12 -0
  16. package/dist/options.js +47 -0
  17. package/init/docula.config.cjs +10 -0
  18. package/init/favicon.ico +0 -0
  19. package/init/logo.png +0 -0
  20. package/init/variables.css +30 -0
  21. package/package.json +58 -91
  22. package/{templates/default/assets/css/styles → template/css}/home.css +20 -18
  23. package/{init/_includes/assets/css/styles → template/css}/index.css +7 -0
  24. package/template/includes/footer.hbs +10 -0
  25. package/template/includes/header.hbs +17 -0
  26. package/template/includes/landing/content.hbs +63 -0
  27. package/template/includes/landing/hero.hbs +3 -0
  28. package/template/includes/scripts.hbs +4 -0
  29. package/template/index.hbs +16 -0
  30. package/template/releases.hbs +45 -0
  31. package/bin/docula.js +0 -7
  32. package/dist/config.d.ts +0 -21
  33. package/dist/config.d.ts.map +0 -1
  34. package/dist/config.js +0 -78
  35. package/dist/config.js.map +0 -1
  36. package/dist/docula-plugin.d.ts +0 -9
  37. package/dist/docula-plugin.d.ts.map +0 -1
  38. package/dist/docula-plugin.js +0 -2
  39. package/dist/docula-plugin.js.map +0 -1
  40. package/dist/docula.d.ts.map +0 -1
  41. package/dist/docula.js.map +0 -1
  42. package/dist/eleventy/filters.d.ts +0 -2
  43. package/dist/eleventy/filters.d.ts.map +0 -1
  44. package/dist/eleventy/filters.js +0 -10
  45. package/dist/eleventy/filters.js.map +0 -1
  46. package/dist/eleventy/global-data.d.ts +0 -3
  47. package/dist/eleventy/global-data.d.ts.map +0 -1
  48. package/dist/eleventy/global-data.js +0 -2
  49. package/dist/eleventy/global-data.js.map +0 -1
  50. package/dist/eleventy/shortcodes.d.ts +0 -4
  51. package/dist/eleventy/shortcodes.d.ts.map +0 -1
  52. package/dist/eleventy/shortcodes.js +0 -18
  53. package/dist/eleventy/shortcodes.js.map +0 -1
  54. package/dist/eleventy.d.ts +0 -24
  55. package/dist/eleventy.d.ts.map +0 -1
  56. package/dist/eleventy.js +0 -82
  57. package/dist/eleventy.js.map +0 -1
  58. package/dist/index.d.ts +0 -9
  59. package/dist/index.d.ts.map +0 -1
  60. package/dist/index.js +0 -67
  61. package/dist/index.js.map +0 -1
  62. package/dist/logger.d.ts +0 -4
  63. package/dist/logger.d.ts.map +0 -1
  64. package/dist/logger.js +0 -20
  65. package/dist/logger.js.map +0 -1
  66. package/dist/plugins/algolia.d.ts +0 -21
  67. package/dist/plugins/algolia.d.ts.map +0 -1
  68. package/dist/plugins/algolia.js +0 -54
  69. package/dist/plugins/algolia.js.map +0 -1
  70. package/dist/plugins/github.d.ts +0 -16
  71. package/dist/plugins/github.d.ts.map +0 -1
  72. package/dist/plugins/github.js +0 -68
  73. package/dist/plugins/github.js.map +0 -1
  74. package/dist/plugins/index.d.ts +0 -18
  75. package/dist/plugins/index.d.ts.map +0 -1
  76. package/dist/plugins/index.js +0 -16
  77. package/dist/plugins/index.js.map +0 -1
  78. package/dist/plugins/npm.d.ts +0 -14
  79. package/dist/plugins/npm.d.ts.map +0 -1
  80. package/dist/plugins/npm.js +0 -36
  81. package/dist/plugins/npm.js.map +0 -1
  82. package/dist/plugins/pagefind.d.ts +0 -10
  83. package/dist/plugins/pagefind.d.ts.map +0 -1
  84. package/dist/plugins/pagefind.js +0 -22
  85. package/dist/plugins/pagefind.js.map +0 -1
  86. package/dist/plugins/robots.d.ts +0 -14
  87. package/dist/plugins/robots.d.ts.map +0 -1
  88. package/dist/plugins/robots.js +0 -34
  89. package/dist/plugins/robots.js.map +0 -1
  90. package/dist/plugins/sitemap.d.ts +0 -11
  91. package/dist/plugins/sitemap.d.ts.map +0 -1
  92. package/dist/plugins/sitemap.js +0 -27
  93. package/dist/plugins/sitemap.js.map +0 -1
  94. package/dist/schemas.d.ts +0 -21
  95. package/dist/schemas.d.ts.map +0 -1
  96. package/dist/schemas.js +0 -25
  97. package/dist/schemas.js.map +0 -1
  98. package/dist/tools/__mocks__/inquirer-prompt.d.ts +0 -20
  99. package/dist/tools/__mocks__/inquirer-prompt.d.ts.map +0 -1
  100. package/dist/tools/__mocks__/inquirer-prompt.js +0 -19
  101. package/dist/tools/__mocks__/inquirer-prompt.js.map +0 -1
  102. package/dist/tools/__mocks__/path.d.ts +0 -5
  103. package/dist/tools/__mocks__/path.d.ts.map +0 -1
  104. package/dist/tools/__mocks__/path.js +0 -7
  105. package/dist/tools/__mocks__/path.js.map +0 -1
  106. package/dist/tools/inquirer-prompt.d.ts +0 -11
  107. package/dist/tools/inquirer-prompt.d.ts.map +0 -1
  108. package/dist/tools/inquirer-prompt.js +0 -139
  109. package/dist/tools/inquirer-prompt.js.map +0 -1
  110. package/dist/tools/path.d.ts +0 -4
  111. package/dist/tools/path.d.ts.map +0 -1
  112. package/dist/tools/path.js +0 -6
  113. package/dist/tools/path.js.map +0 -1
  114. package/dist/tools/tools.d.ts +0 -3
  115. package/dist/tools/tools.d.ts.map +0 -1
  116. package/dist/tools/tools.js +0 -10
  117. package/dist/tools/tools.js.map +0 -1
  118. package/dist/types/config.d.ts +0 -8
  119. package/dist/types/config.d.ts.map +0 -1
  120. package/dist/types/config.js +0 -2
  121. package/dist/types/config.js.map +0 -1
  122. package/init/_data/site.json +0 -5
  123. package/init/_includes/assets/css/styles/home.css +0 -305
  124. package/init/_includes/assets/css/styles/search/algolia.css +0 -125
  125. package/init/_includes/assets/css/styles/search/pagefind.css +0 -60
  126. package/init/_includes/assets/css/styles/variables.css +0 -30
  127. package/init/_includes/assets/images/docula-logo-horizontal.webp +0 -0
  128. package/init/_includes/assets/images/logo.svg +0 -10
  129. package/init/_includes/doc.njk +0 -22
  130. package/init/_includes/landing/landingHero.njk +0 -8
  131. package/init/_includes/landing/singlePage.njk +0 -24
  132. package/init/_includes/multipage/header.njk +0 -23
  133. package/init/_includes/multipage/homeHeader.njk +0 -20
  134. package/init/_includes/multipage/main.njk +0 -47
  135. package/init/_includes/multipage/scripts.njk +0 -47
  136. package/init/_includes/multipage/searchEngine.njk +0 -5
  137. package/init/_includes/multipage/searchModal.njk +0 -19
  138. package/init/_includes/multipage/sidebar.njk +0 -50
  139. package/init/_includes/search/algolia.njk +0 -98
  140. package/init/_includes/search/pagefind.njk +0 -66
  141. package/init/_includes/shared/footer.njk +0 -4
  142. package/init/_includes/shared/head.njk +0 -15
  143. package/init/_includes/shared/highlightScript.njk +0 -6
  144. package/init/_includes/shared/homeData.njk +0 -49
  145. package/init/api/Readme.md +0 -3
  146. package/init/docs/Readme.md +0 -83
  147. package/init/docs/docs.json +0 -13
  148. package/init/index.njk +0 -28
  149. package/init/releases.njk +0 -38
  150. package/init/search-index.md +0 -14
  151. package/init/versions.njk +0 -40
  152. package/templates/default/assets/css/highlight/highlight.min.js +0 -1433
  153. package/templates/default/assets/css/highlight/styles/base16/dracula.min.css +0 -7
  154. package/templates/default/assets/css/styles/index.css +0 -912
  155. package/templates/default/assets/css/styles/search/algolia.css +0 -125
  156. package/templates/default/assets/css/styles/search/pagefind.css +0 -60
  157. package/templates/default/assets/css/styles/variables.css +0 -30
  158. package/templates/default/assets/images/docula-logo-horizontal.webp +0 -0
  159. package/templates/default/assets/images/logo.svg +0 -10
  160. package/templates/default/doc.njk +0 -22
  161. package/templates/default/index.njk +0 -28
  162. package/templates/default/landing/landingHero.njk +0 -8
  163. package/templates/default/landing/singlePage.njk +0 -24
  164. package/templates/default/multipage/header.njk +0 -23
  165. package/templates/default/multipage/homeHeader.njk +0 -20
  166. package/templates/default/multipage/main.njk +0 -47
  167. package/templates/default/multipage/scripts.njk +0 -47
  168. package/templates/default/multipage/searchEngine.njk +0 -5
  169. package/templates/default/multipage/searchModal.njk +0 -19
  170. package/templates/default/multipage/sidebar.njk +0 -50
  171. package/templates/default/releases.njk +0 -38
  172. package/templates/default/search/algolia.njk +0 -98
  173. package/templates/default/search/pagefind.njk +0 -66
  174. package/templates/default/search-index.md +0 -14
  175. package/templates/default/shared/footer.njk +0 -4
  176. package/templates/default/shared/head.njk +0 -15
  177. package/templates/default/shared/highlightScript.njk +0 -6
  178. package/templates/default/shared/homeData.njk +0 -49
  179. package/templates/default/versions.njk +0 -40
  180. /package/{init/_includes/assets → template}/css/highlight/highlight.min.js +0 -0
  181. /package/{init/_includes/assets → template}/css/highlight/styles/base16/dracula.min.css +0 -0
@@ -1,66 +0,0 @@
1
- <link href="/_pagefind/pagefind-ui.css" rel="stylesheet">
2
- <script src="/_pagefind/pagefind-ui.js" type="text/javascript"></script>
3
- <script>
4
- window.addEventListener('DOMContentLoaded', (event) => {
5
- new PagefindUI({
6
- element: "#search",
7
- showImages: false,
8
- debounceTimeoutMs: 500
9
- });
10
- });
11
- </script>
12
-
13
- <!--pagefind UI-->
14
- <script>
15
- const searchModal = document.querySelector('#search-modal');
16
- const searchModalContainer = document.querySelector('#search-container');
17
- const closeModalBtn = document.querySelector('#close-modal-btn');
18
- const searchBtn = document.querySelector('#search-btn');
19
-
20
- const closeEmptyModal = (e) => {
21
- const pagefindInput = document.querySelector('.pagefind-ui__search-input');
22
- if(pagefindInput) {
23
- if(!pagefindInput.value ) {
24
- if (pagefindInput === e.target || pagefindInput.contains(e.target)) return;
25
- searchModal.classList.remove('show-modal');
26
- }
27
- }
28
- }
29
-
30
- const closeDesktopModal = (e) => {
31
- const pagefindInput = document.querySelector('.pagefind-ui__search-input');
32
- if(isDesktop && pagefindInput) {
33
- if(pagefindInput.value ) {
34
- if (searchModalContainer === e.target || searchModalContainer.contains(e.target)) return;
35
- searchModal.classList.remove('show-modal');
36
- }
37
- }
38
- }
39
-
40
- searchModal.addEventListener('click', (e) => {
41
- closeEmptyModal(e);
42
- closeDesktopModal(e)
43
- });
44
-
45
- const autofocusInput = () => {
46
- const pagefindInput = document.querySelector('.pagefind-ui__search-input');
47
- if (pagefindInput) {
48
- pagefindInput.focus();
49
- }
50
- };
51
-
52
- const handleSearchModal = () => {
53
- searchModal.classList.add('show-modal');
54
- autofocusInput()
55
- };
56
- searchBtn.addEventListener('click', handleSearchModal);
57
-
58
-
59
- if(closeModalBtn) {
60
- closeModalBtn.addEventListener('click', () => {
61
- searchModal.classList.remove('show-modal');
62
- });
63
- }
64
-
65
-
66
- </script>
@@ -1,14 +0,0 @@
1
- ---
2
- permalink: algolia.json
3
- templateEngineOverride: njk
4
- ---
5
- [
6
- {%- for item in collections.docs -%}
7
- {
8
- "url" : "{{ item.url }}",
9
- "title" : "{{ item.data.title }}",
10
- "description" : "{{ item.templateContent | striptags }}",
11
- "objectID": "{{ item.url }}"
12
- }{% if not loop.last %},{% else %}{%- endif -%}
13
- {%- endfor -%}
14
- ]
@@ -1,4 +0,0 @@
1
- <footer>
2
- Powered by <a href="https://www.docula.org" target="_blank" rel="noopener noreferrer"><img src="/assets/images/docula-logo-horizontal.webp" alt="Docula logo" width="122" height="32" />
3
- </a>
4
- </footer>
@@ -1,15 +0,0 @@
1
- <meta charset="UTF-8">
2
- <meta name="viewport" content="width=device-width, initial-scale=1">
3
- <link rel="stylesheet" href="/assets/css/styles/variables.css">
4
- <link rel="stylesheet" href="/assets/css/styles/index.css">
5
- <link rel="stylesheet" href="/assets/css/styles/home.css">
6
- <link rel="preconnect" href="https://fonts.googleapis.com">
7
- <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
8
- <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;600;700&display=swap" rel="stylesheet">
9
- <link rel="stylesheet" href="/assets/css/highlight/styles/base16/dracula.min.css">
10
- {% if config.searchEngine == 'algolia' %}
11
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/instantsearch.css@8.0.0/themes/reset-min.css" integrity="sha256-2AeJLzExpZvqLUxMfcs+4DWcMwNfpnjUeAAvEtPr0wU=" crossorigin="anonymous">
12
- <link rel="stylesheet" href="/assets/css/styles/search/algolia.css">
13
- {% elif config.searchEngine == 'pagefind' %}
14
- <link rel="stylesheet" href="/assets/css/styles/search/pagefind.css">
15
- {% endif %}
@@ -1,6 +0,0 @@
1
- <script src="/assets/css/highlight/highlight.min.js"></script>
2
- <script>
3
- document.addEventListener('DOMContentLoaded', () => {
4
- hljs.highlightAll()
5
- });
6
- </script>
@@ -1,49 +0,0 @@
1
- <section class="home-container">
2
- {% if github %}
3
- {% if (github.contributors) and (github.contributors.length) %}
4
- <div class="content-container">
5
- <h2 class="home-title">Contributors</h2>
6
- <div class="facepile-container">
7
- <div class="facepile">
8
- {% for contributor in github.contributors %}
9
- <a href="{{ contributor.html_url }}" target="_blank" title="{{ contributor.login }}" rel="noopener noreferrer">
10
- <img src="{{ contributor.avatar_url }}" alt="{{ contributor.login }}" />
11
- </a>
12
- {% endfor %}
13
- </div>
14
- </div>
15
- </div>
16
- {% endif %}
17
-
18
- {% if (github.releases) and (github.releases.length) %}
19
- <div class="content-container">
20
- <h2 class="home-title">Latest's Releases</h2>
21
- {% set releasesLength = github.releases | length %}
22
- {% for release in github.releases %}
23
- {% if loop.index <= 3 %}
24
- <div class="release">
25
- <div class="release-header">
26
- <a class="release-title" href="{{ release.html_url }}" target="_blank" rel="noopener noreferrer">{{ release.name }}</a>
27
- <span class="release-date">{% formatDate "MMM dd, yyyy", release.published_at %}</span>
28
- </div>
29
- <div class="release-body">
30
- {% if release.body %}
31
- <p>{% parseRelease release.body %}</p>
32
- {% endif %}
33
- </div>
34
- </div>
35
- {% endif %}
36
- {% endfor %}
37
-
38
- {% if releasesLength > 5 %}
39
- <a class="release-btn" href="/versions">
40
- All Releases
41
- <span>→</span>
42
- </a>
43
- {% endif %}
44
- </div>
45
- {% endif %}
46
-
47
- {% endif %}
48
-
49
- </section>
@@ -1,40 +0,0 @@
1
- ---
2
- permalink: /releases/
3
- ---
4
- <!DOCTYPE html>
5
- <html lang="en">
6
- <head>
7
- {% include "shared/head.njk" %}
8
- <title>{{site.name}} - Releases</title>
9
- </head>
10
-
11
- <body>
12
- {% include "multipage/homeHeader.njk" %}
13
-
14
- <main class="home-container">
15
- <div class="content-container versions-container">
16
- <h2 class="home-title">Releases</h2>
17
- {% for release in github.releases %}
18
- <div class="release">
19
- <div class="release-header">
20
- <a class="release-title" href="{{ release.html_url }}" target="_blank" rel="noopener noreferrer">{{ release.name }}</a>
21
- <span class="release-date">{% formatDate "MMM dd, yyyy", release.published_at %}</span>
22
- </div>
23
- <div class="release-body">
24
- {% if release.body %}
25
- <p>{% parseRelease release.body %}</p>
26
- {% endif %}
27
- </div>
28
- </div>
29
- {% endfor %}
30
- </div>
31
-
32
- </main>
33
-
34
- {% include "multipage/searchModal.njk" %}
35
- {% include "multipage/scripts.njk" %}
36
- {% include "shared/highlightScript.njk" %}
37
- {% include "multipage/searchEngine.njk" %}
38
-
39
- </body>
40
- </html>