docula 0.3.6 → 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 (152) 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 -21
  8. package/dist/docula.js +126 -165
  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 +63 -95
  22. package/{init/_includes/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 -53
  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/search/algolia.css +0 -125
  124. package/init/_includes/assets/css/styles/search/pagefind.css +0 -60
  125. package/init/_includes/assets/css/styles/variables.css +0 -30
  126. package/init/_includes/assets/images/docula-logo-horizontal.webp +0 -0
  127. package/init/_includes/assets/images/logo.svg +0 -10
  128. package/init/_includes/doc.njk +0 -22
  129. package/init/_includes/landing/landingHero.njk +0 -8
  130. package/init/_includes/landing/singlePage.njk +0 -24
  131. package/init/_includes/multipage/header.njk +0 -23
  132. package/init/_includes/multipage/homeHeader.njk +0 -20
  133. package/init/_includes/multipage/main.njk +0 -47
  134. package/init/_includes/multipage/scripts.njk +0 -47
  135. package/init/_includes/multipage/searchEngine.njk +0 -5
  136. package/init/_includes/multipage/searchModal.njk +0 -19
  137. package/init/_includes/multipage/sidebar.njk +0 -50
  138. package/init/_includes/search/algolia.njk +0 -98
  139. package/init/_includes/search/pagefind.njk +0 -66
  140. package/init/_includes/shared/footer.njk +0 -4
  141. package/init/_includes/shared/head.njk +0 -15
  142. package/init/_includes/shared/highlightScript.njk +0 -6
  143. package/init/_includes/shared/homeData.njk +0 -49
  144. package/init/api/Readme.md +0 -3
  145. package/init/docs/Readme.md +0 -83
  146. package/init/docs/docs.json +0 -13
  147. package/init/index.njk +0 -28
  148. package/init/releases.njk +0 -38
  149. package/init/search-index.md +0 -14
  150. package/init/versions.njk +0 -40
  151. /package/{init/_includes/assets → template}/css/highlight/highlight.min.js +0 -0
  152. /package/{init/_includes/assets → template}/css/highlight/styles/base16/dracula.min.css +0 -0
@@ -0,0 +1,47 @@
1
+ import path from 'node:path';
2
+ import process from 'node:process';
3
+ export class DoculaOptions {
4
+ templatePath = path.join(import.meta.url, '../../template').replace('file:', '');
5
+ outputPath = path.join(process.cwd(), './dist');
6
+ sitePath = path.join(process.cwd(), './site');
7
+ githubPath = 'jaredwray/docula';
8
+ siteTitle = 'docula';
9
+ siteDescription = 'Beautiful Website for Your Projects';
10
+ siteUrl = 'https://docula.org';
11
+ port = 3000;
12
+ constructor(options) {
13
+ if (options) {
14
+ this.parseOptions(options);
15
+ }
16
+ }
17
+ parseOptions(options) {
18
+ if (options.templatePath) {
19
+ this.templatePath = options.templatePath;
20
+ this.templatePath = path.join(process.cwd(), this.templatePath);
21
+ }
22
+ if (options.outputPath) {
23
+ this.outputPath = options.outputPath;
24
+ this.githubPath = path.join(process.cwd(), this.outputPath);
25
+ }
26
+ if (options.sitePath) {
27
+ this.sitePath = options.sitePath;
28
+ this.sitePath = path.join(process.cwd(), this.sitePath);
29
+ }
30
+ if (options.githubPath) {
31
+ this.githubPath = options.githubPath;
32
+ }
33
+ if (options.siteTitle) {
34
+ this.siteTitle = options.siteTitle;
35
+ }
36
+ if (options.siteDescription) {
37
+ this.siteDescription = options.siteDescription;
38
+ }
39
+ if (options.siteUrl) {
40
+ this.siteUrl = options.siteUrl;
41
+ }
42
+ if (options.port) {
43
+ this.port = options.port;
44
+ }
45
+ }
46
+ }
47
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3B0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9vcHRpb25zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sSUFBSSxNQUFNLFdBQVcsQ0FBQztBQUM3QixPQUFPLE9BQU8sTUFBTSxjQUFjLENBQUM7QUFFbkMsTUFBTSxPQUFPLGFBQWE7SUFDbEIsWUFBWSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsZ0JBQWdCLENBQUMsQ0FBQyxPQUFPLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQyxDQUFDO0lBQ2pGLFVBQVUsR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBRSxRQUFRLENBQUMsQ0FBQztJQUNoRCxRQUFRLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLEVBQUUsUUFBUSxDQUFDLENBQUM7SUFDOUMsVUFBVSxHQUFHLGtCQUFrQixDQUFDO0lBQ2hDLFNBQVMsR0FBRyxRQUFRLENBQUM7SUFDckIsZUFBZSxHQUFHLHFDQUFxQyxDQUFDO0lBQ3hELE9BQU8sR0FBRyxvQkFBb0IsQ0FBQztJQUMvQixJQUFJLEdBQUcsSUFBSSxDQUFDO0lBRW5CLFlBQVksT0FBaUM7UUFDNUMsSUFBSSxPQUFPLEVBQUUsQ0FBQztZQUNiLElBQUksQ0FBQyxZQUFZLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDNUIsQ0FBQztJQUNGLENBQUM7SUFFTSxZQUFZLENBQUMsT0FBNEI7UUFDL0MsSUFBSSxPQUFPLENBQUMsWUFBWSxFQUFFLENBQUM7WUFDMUIsSUFBSSxDQUFDLFlBQVksR0FBRyxPQUFPLENBQUMsWUFBc0IsQ0FBQztZQUNuRCxJQUFJLENBQUMsWUFBWSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFFLElBQUksQ0FBQyxZQUFZLENBQUMsQ0FBQztRQUNqRSxDQUFDO1FBRUQsSUFBSSxPQUFPLENBQUMsVUFBVSxFQUFFLENBQUM7WUFDeEIsSUFBSSxDQUFDLFVBQVUsR0FBRyxPQUFPLENBQUMsVUFBb0IsQ0FBQztZQUMvQyxJQUFJLENBQUMsVUFBVSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFFLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUM3RCxDQUFDO1FBRUQsSUFBSSxPQUFPLENBQUMsUUFBUSxFQUFFLENBQUM7WUFDdEIsSUFBSSxDQUFDLFFBQVEsR0FBRyxPQUFPLENBQUMsUUFBa0IsQ0FBQztZQUMzQyxJQUFJLENBQUMsUUFBUSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFFLElBQUksQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUN6RCxDQUFDO1FBRUQsSUFBSSxPQUFPLENBQUMsVUFBVSxFQUFFLENBQUM7WUFDeEIsSUFBSSxDQUFDLFVBQVUsR0FBRyxPQUFPLENBQUMsVUFBb0IsQ0FBQztRQUNoRCxDQUFDO1FBRUQsSUFBSSxPQUFPLENBQUMsU0FBUyxFQUFFLENBQUM7WUFDdkIsSUFBSSxDQUFDLFNBQVMsR0FBRyxPQUFPLENBQUMsU0FBbUIsQ0FBQztRQUM5QyxDQUFDO1FBRUQsSUFBSSxPQUFPLENBQUMsZUFBZSxFQUFFLENBQUM7WUFDN0IsSUFBSSxDQUFDLGVBQWUsR0FBRyxPQUFPLENBQUMsZUFBeUIsQ0FBQztRQUMxRCxDQUFDO1FBRUQsSUFBSSxPQUFPLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDckIsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUMsT0FBaUIsQ0FBQztRQUMxQyxDQUFDO1FBRUQsSUFBSSxPQUFPLENBQUMsSUFBSSxFQUFFLENBQUM7WUFDbEIsSUFBSSxDQUFDLElBQUksR0FBRyxPQUFPLENBQUMsSUFBYyxDQUFDO1FBQ3BDLENBQUM7SUFDRixDQUFDO0NBQ0QiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgcGF0aCBmcm9tICdub2RlOnBhdGgnO1xuaW1wb3J0IHByb2Nlc3MgZnJvbSAnbm9kZTpwcm9jZXNzJztcblxuZXhwb3J0IGNsYXNzIERvY3VsYU9wdGlvbnMge1xuXHRwdWJsaWMgdGVtcGxhdGVQYXRoID0gcGF0aC5qb2luKGltcG9ydC5tZXRhLnVybCwgJy4uLy4uL3RlbXBsYXRlJykucmVwbGFjZSgnZmlsZTonLCAnJyk7XG5cdHB1YmxpYyBvdXRwdXRQYXRoID0gcGF0aC5qb2luKHByb2Nlc3MuY3dkKCksICcuL2Rpc3QnKTtcblx0cHVibGljIHNpdGVQYXRoID0gcGF0aC5qb2luKHByb2Nlc3MuY3dkKCksICcuL3NpdGUnKTtcblx0cHVibGljIGdpdGh1YlBhdGggPSAnamFyZWR3cmF5L2RvY3VsYSc7XG5cdHB1YmxpYyBzaXRlVGl0bGUgPSAnZG9jdWxhJztcblx0cHVibGljIHNpdGVEZXNjcmlwdGlvbiA9ICdCZWF1dGlmdWwgV2Vic2l0ZSBmb3IgWW91ciBQcm9qZWN0cyc7XG5cdHB1YmxpYyBzaXRlVXJsID0gJ2h0dHBzOi8vZG9jdWxhLm9yZyc7XG5cdHB1YmxpYyBwb3J0ID0gMzAwMDtcblxuXHRjb25zdHJ1Y3RvcihvcHRpb25zPzogUmVjb3JkPHN0cmluZywgdW5rbm93bj4pIHtcblx0XHRpZiAob3B0aW9ucykge1xuXHRcdFx0dGhpcy5wYXJzZU9wdGlvbnMob3B0aW9ucyk7XG5cdFx0fVxuXHR9XG5cblx0cHVibGljIHBhcnNlT3B0aW9ucyhvcHRpb25zOiBSZWNvcmQ8c3RyaW5nLCBhbnk+KSB7XG5cdFx0aWYgKG9wdGlvbnMudGVtcGxhdGVQYXRoKSB7XG5cdFx0XHR0aGlzLnRlbXBsYXRlUGF0aCA9IG9wdGlvbnMudGVtcGxhdGVQYXRoIGFzIHN0cmluZztcblx0XHRcdHRoaXMudGVtcGxhdGVQYXRoID0gcGF0aC5qb2luKHByb2Nlc3MuY3dkKCksIHRoaXMudGVtcGxhdGVQYXRoKTtcblx0XHR9XG5cblx0XHRpZiAob3B0aW9ucy5vdXRwdXRQYXRoKSB7XG5cdFx0XHR0aGlzLm91dHB1dFBhdGggPSBvcHRpb25zLm91dHB1dFBhdGggYXMgc3RyaW5nO1xuXHRcdFx0dGhpcy5naXRodWJQYXRoID0gcGF0aC5qb2luKHByb2Nlc3MuY3dkKCksIHRoaXMub3V0cHV0UGF0aCk7XG5cdFx0fVxuXG5cdFx0aWYgKG9wdGlvbnMuc2l0ZVBhdGgpIHtcblx0XHRcdHRoaXMuc2l0ZVBhdGggPSBvcHRpb25zLnNpdGVQYXRoIGFzIHN0cmluZztcblx0XHRcdHRoaXMuc2l0ZVBhdGggPSBwYXRoLmpvaW4ocHJvY2Vzcy5jd2QoKSwgdGhpcy5zaXRlUGF0aCk7XG5cdFx0fVxuXG5cdFx0aWYgKG9wdGlvbnMuZ2l0aHViUGF0aCkge1xuXHRcdFx0dGhpcy5naXRodWJQYXRoID0gb3B0aW9ucy5naXRodWJQYXRoIGFzIHN0cmluZztcblx0XHR9XG5cblx0XHRpZiAob3B0aW9ucy5zaXRlVGl0bGUpIHtcblx0XHRcdHRoaXMuc2l0ZVRpdGxlID0gb3B0aW9ucy5zaXRlVGl0bGUgYXMgc3RyaW5nO1xuXHRcdH1cblxuXHRcdGlmIChvcHRpb25zLnNpdGVEZXNjcmlwdGlvbikge1xuXHRcdFx0dGhpcy5zaXRlRGVzY3JpcHRpb24gPSBvcHRpb25zLnNpdGVEZXNjcmlwdGlvbiBhcyBzdHJpbmc7XG5cdFx0fVxuXG5cdFx0aWYgKG9wdGlvbnMuc2l0ZVVybCkge1xuXHRcdFx0dGhpcy5zaXRlVXJsID0gb3B0aW9ucy5zaXRlVXJsIGFzIHN0cmluZztcblx0XHR9XG5cblx0XHRpZiAob3B0aW9ucy5wb3J0KSB7XG5cdFx0XHR0aGlzLnBvcnQgPSBvcHRpb25zLnBvcnQgYXMgbnVtYmVyO1xuXHRcdH1cblx0fVxufVxuIl19
@@ -0,0 +1,10 @@
1
+ module.exports.options = {
2
+ templatePath: './template',
3
+ outputPath: './dist',
4
+ sitePath: './site',
5
+ githubPath: 'jaredwray/docula',
6
+ siteTitle: 'Docula',
7
+ siteDescription: 'Beautiful Website for Your Projects',
8
+ siteUrl: 'https://docula.org',
9
+ };
10
+
Binary file
package/init/logo.png ADDED
Binary file
@@ -0,0 +1,30 @@
1
+ :root {
2
+ --font-family: 'Open Sans', sans-serif;
3
+
4
+ --color-primary: #322d3c;
5
+ --color-secondary: #8cdc00;
6
+ --color-secondary-dark: #8cdc00;
7
+ --color-text: #322d3c;
8
+
9
+ --background: #ffffff;
10
+ --home-background: #ffffff;
11
+ --header-background: #ffffff;
12
+
13
+ --sidebar-background: #ffffff;
14
+ --sidebar-text: #322d3c;
15
+ --sidebar-text-active: #7d7887;
16
+
17
+ --border: rgba(238,238,245,1);
18
+
19
+ --background-search-highlight: var(--color-secondary-dark);
20
+ --color-search-highlight: #ffffff;
21
+ --search-input-background: var(--header-background);
22
+
23
+ --code: rgba(238,238,245,1);
24
+
25
+ --pagefind-ui-text: var(--color-text) !important;
26
+ --pagefind-ui-font: var(--font-family) !important;
27
+ --pagefind-ui-background: var(--background) !important;
28
+ --pagefind-ui-border: var(--border) !important;
29
+ --pagefind-ui-scale: .9 !important;
30
+ }
package/package.json CHANGED
@@ -1,112 +1,80 @@
1
1
  {
2
2
  "name": "docula",
3
- "version": "0.3.6",
4
- "description": "Open Source Static Site Generator",
5
- "exports": "./dist/docula.js",
6
- "types": "./dist/docula.d.ts",
3
+ "version": "0.4.0",
4
+ "description": "Beautiful Website for Your Projects",
7
5
  "type": "module",
6
+ "exports": "./dist/index.js",
7
+ "types": "./dist/index.d.ts",
8
+ "repository": "https://github.com/jaredwray/docula.git",
9
+ "author": "Jared Wray <me@jaredwray.com>",
8
10
  "engines": {
9
- "node": ">=14.16"
11
+ "node": ">=18.0.0"
10
12
  },
13
+ "license": "MIT",
14
+ "keywords": [
15
+ "static-site-generator",
16
+ "static-site",
17
+ "open source",
18
+ "ssg",
19
+ "documentation",
20
+ "website",
21
+ "templates",
22
+ "generator",
23
+ "framework",
24
+ "docula",
25
+ "writer",
26
+ "html",
27
+ "markdown",
28
+ "handlebars"
29
+ ],
11
30
  "scripts": {
12
- "build": "tsc -p .",
13
- "clean": "rm -rf dist && rm -rf test/data/site && rm -rf node_modules",
14
- "test": "xo --fix && jest --coverage",
15
- "test:code": "npm run build && node ./bin/docula.js",
16
- "lint": "xo --fix",
17
- "build:site": "npm run build && node ./bin/docula.js"
18
- },
19
- "repository": {
20
- "type": "git",
21
- "url": "git+https://github.com/jaredwray/docula.git"
31
+ "clean": "rimraf ./dist ./coverage ./node_modules ./package-lock.json ./yarn.lock ./site/README.md",
32
+ "build": "rimraf ./dist && tsc",
33
+ "build-site": "rimraf ./site/README.md && node bin/docula.mjs build -s ./site -o ./site-output",
34
+ "test": "xo --fix && vitest run --coverage",
35
+ "serve": "rimraf ./site/README.md && node bin/docula.mjs serve -s ./site -o ./site-output",
36
+ "prepare": "yarn run build"
22
37
  },
23
38
  "bin": {
24
- "docula": "./bin/docula.js"
39
+ "docula": "./bin/docula.mjs"
25
40
  },
26
- "keywords": [
27
- "open",
28
- "source",
29
- "static",
30
- "site",
31
- "github"
32
- ],
33
- "author": "Jared Wray (me@jaredwray.com)",
34
- "license": "MIT",
35
- "bugs": {
36
- "url": "https://github.com/jaredwray/docula/issues"
41
+ "dependencies": {
42
+ "@markdoc/markdoc": "^0.4.0",
43
+ "axios": "^1.6.2",
44
+ "ecto": "^2.4.1",
45
+ "express": "^4.18.2",
46
+ "feed": "^4.2.2",
47
+ "fs-extra": "^11.2.0",
48
+ "gray-matter": "^4.0.3",
49
+ "js-yaml": "^4.1.0",
50
+ "keyv": "^4.5.4",
51
+ "ts-node": "^10.9.2",
52
+ "update-notifier": "^7.0.0"
37
53
  },
38
- "homepage": "https://github.com/jaredwray/docula#readme",
39
54
  "devDependencies": {
40
- "@types/express": "^4.17.17",
41
- "@types/fs-extra": "^11.0.2",
42
- "@types/inquirer": "^9.0.3",
43
- "@types/jest": "^29.5.5",
44
- "@types/luxon": "^3.3.2",
45
- "jest": "^29.7.0",
46
- "jest-resolve": "^29.7.0",
47
- "jest-ts-webcompat-resolver": "^1.0.0",
48
- "ts-jest": "^29.1.1",
49
- "ts-jest-resolver": "^2.0.1",
50
- "typescript": "^5.2.2",
51
- "webpack": "^5.88.2",
55
+ "@types/express": "^4.17.21",
56
+ "@types/fs-extra": "^11.0.4",
57
+ "@types/js-yaml": "^4.0.9",
58
+ "@types/node": "^20.10.5",
59
+ "@types/update-notifier": "^6.0.8",
60
+ "@vitest/coverage-v8": "^1.1.0",
61
+ "rimraf": "^5.0.5",
62
+ "typescript": "^5.3.3",
63
+ "vitest": "^1.1.0",
64
+ "webpack": "^5.89.0",
52
65
  "xo": "^0.56.0"
53
66
  },
54
- "dependencies": {
55
- "@11ty/eleventy": "^1.0.2",
56
- "@11ty/eleventy-navigation": "^0.3.5",
57
- "@types/markdown-it": "^13.0.1",
58
- "ajv": "^8.12.0",
59
- "algoliasearch": "^4.20.0",
60
- "axios": "^1.5.0",
61
- "commander": "^11.0.0",
62
- "dayjs": "^1.11.9",
63
- "dotenv": "^16.3.1",
64
- "download-stats": "^0.3.4",
65
- "ecto": "^2.2.0",
66
- "eleventy-plugin-toc": "^1.1.5",
67
- "express": "^4.18.2",
68
- "fs-extra": "^11.1.1",
69
- "inquirer": "^9.2.11",
70
- "instantsearch.js": "^4.56.11",
71
- "luxon": "^3.4.3",
72
- "markdown-it": "^13.0.1",
73
- "markdown-it-anchor": "^8.6.7",
74
- "node-fetch": "3.3.2",
75
- "winston": "^3.10.0"
67
+ "xo": {
68
+ "ignores": [
69
+ "docula.config.*",
70
+ "vitest.config.mjs",
71
+ "bin/docula.js"
72
+ ]
76
73
  },
77
74
  "files": [
78
75
  "dist",
79
- "bin",
80
- "init"
81
- ],
82
- "xo": {
83
- "rules": {
84
- "@typescript-eslint/no-unsafe-assignment": 0,
85
- "@typescript-eslint/no-unsafe-return": 0,
86
- "@typescript-eslint/no-unsafe-argument": 0,
87
- "@typescript-eslint/no-unsafe-call": 0
88
- }
89
- },
90
- "jest": {
91
- "moduleFileExtensions": [
92
- "ts",
93
- "js"
94
- ],
95
- "transform": {
96
- "^.+\\.[jt]sx?$": [
97
- "ts-jest",
98
- {
99
- "useESM": true,
100
- "tsconfig": "tsconfig.json"
101
- }
102
- ]
103
- },
104
- "resolver": "jest-ts-webcompat-resolver",
105
- "testMatch": [
106
- "**/test/*.test.(ts)",
107
- "**/test/plugins/*.test.(ts)",
108
- "**/test/eleventy/*.test.(ts)"
109
- ],
110
- "testEnvironment": "node"
111
- }
76
+ "init",
77
+ "template",
78
+ "bin"
79
+ ]
112
80
  }
@@ -9,12 +9,15 @@
9
9
  }
10
10
 
11
11
  .home-hero {
12
- padding: 56px 0 72px;
12
+ display: flex;
13
+ justify-content: center;
14
+ height: 20vh;
13
15
  background-color: var(--home-background)
14
16
  }
15
17
 
16
18
  .home-container {
17
- margin: 32px 32px 48px;
19
+ max-width: 90%;
20
+ margin: 0 auto;
18
21
  color: var(--color-text);
19
22
  }
20
23
 
@@ -47,7 +50,15 @@
47
50
 
48
51
  .home-hero img {
49
52
  width: 100%;
50
- max-width: 120px;
53
+ max-width: 200px;
54
+ }
55
+
56
+ .github-fork-ribbon {
57
+ position: fixed !important;
58
+ }
59
+
60
+ .github-fork-ribbon:before {
61
+ background-color: var(--color-primary) !important;
51
62
  }
52
63
 
53
64
  .content-container {
@@ -180,6 +191,7 @@ footer {
180
191
  justify-content: center;
181
192
  align-items: center;
182
193
  border-top: 1px solid var(--border);
194
+ width: 100%;
183
195
  }
184
196
 
185
197
  footer img {
@@ -188,20 +200,15 @@ footer img {
188
200
  }
189
201
 
190
202
  @media screen and (min-width: 640px) {
191
- .home-hero {
192
- padding: 64px 0 72px;
193
- }
194
-
195
203
  .home-container {
196
- margin-left: 64px;
197
- margin-right: 64px;
204
+ max-width: 82%;
198
205
  }
199
206
  }
200
207
 
201
208
 
202
209
  @media screen and (min-width: 768px) {
203
210
  .home-hero {
204
- padding: 72px 0;
211
+ height: 40vh;
205
212
  }
206
213
 
207
214
  .header-logo {
@@ -209,7 +216,7 @@ footer img {
209
216
  }
210
217
 
211
218
  .home-hero img {
212
- max-width: 180px;
219
+ max-width: 340px;
213
220
  }
214
221
 
215
222
  .content-container {
@@ -228,7 +235,6 @@ footer img {
228
235
 
229
236
  @media screen and (min-width: 992px) {
230
237
  .home-container {
231
- margin: 72px auto 56px;
232
238
  max-width: 70%;
233
239
  }
234
240
 
@@ -240,10 +246,6 @@ footer img {
240
246
  font-size: 24px;
241
247
  }
242
248
 
243
- .home-hero {
244
- padding: 120px 0;
245
- }
246
-
247
249
  .nav {
248
250
  padding-right: 56px;
249
251
  width: 100%;
@@ -255,7 +257,7 @@ footer img {
255
257
  }
256
258
 
257
259
  .home-hero img {
258
- max-width: 250px;
260
+ max-width: 600px;
259
261
  }
260
262
 
261
263
  .home-title {
@@ -276,7 +278,7 @@ footer img {
276
278
  }
277
279
 
278
280
  footer img {
279
- height: 40px;
281
+ height: 28px;
280
282
  width: auto;
281
283
  }
282
284
  }
@@ -25,6 +25,7 @@ body {
25
25
  color: var(--color-text);
26
26
  font-size: 16px;
27
27
  background-color: var(--background);
28
+ min-height: 100vh;
28
29
  }
29
30
 
30
31
  a {
@@ -45,6 +46,12 @@ button {
45
46
  font-size: 14px;
46
47
  }
47
48
 
49
+ hr {
50
+ border-top: 0;
51
+ border-bottom: 1px solid var(--border);
52
+ margin: 12px 0;
53
+ }
54
+
48
55
  .nav {
49
56
  padding-left: 16px;
50
57
  padding-right: 16px;
@@ -0,0 +1,10 @@
1
+ <footer>
2
+ Powered by
3
+ <a href="https://docula.org/" target="_blank" rel="noopener noreferrer"><img
4
+ src="https://docula.org/logo.svg"
5
+ alt="docula logo"
6
+ width="122"
7
+ height="32"
8
+ />
9
+ </a>
10
+ </footer>
@@ -0,0 +1,17 @@
1
+ <meta charset="UTF-8" />
2
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
3
+ <link rel="stylesheet" href="/css/variables.css" />
4
+ <link rel="stylesheet" href="/css/index.css" />
5
+ <link rel="stylesheet" href="/css/home.css" />
6
+ <link rel="preconnect" href="https://fonts.googleapis.com" />
7
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
8
+ <link
9
+ href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;600;700&display=swap"
10
+ rel="stylesheet"
11
+ />
12
+ <link
13
+ rel="stylesheet"
14
+ href="https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.3/gh-fork-ribbon.min.css"
15
+ />
16
+ <link rel="stylesheet" href="/css/highlight/styles/base16/dracula.min.css" />
17
+ <link rel="icon" href="/favicon.ico" />
@@ -0,0 +1,63 @@
1
+ <article class="home-container">
2
+ <div class="content">{{{content}}}</div>
3
+
4
+ {{#if github}}
5
+ {{#if github.contributors}}
6
+ <div class="content-container">
7
+ <h2 class="home-title">Contributors</h2>
8
+ <div class="facepile-container">
9
+ <div class="facepile">
10
+ {{#each github.contributors}}
11
+ <a
12
+ href="{{html_url}}"
13
+ target="_blank"
14
+ title="{{login}}"
15
+ rel="noopener noreferrer"
16
+ >
17
+ <img src="{{avatar_url}}" alt="{{login}}" />
18
+ </a>
19
+ {{/each}}
20
+ </div>
21
+ </div>
22
+ </div>
23
+ {{/if}}
24
+
25
+ {{#if github.releases}}
26
+ <div class="content-container">
27
+ <h2 class="home-title">Latest's Releases</h2>
28
+ {{#each github.releases as |release|}}
29
+ {{#if (lt @index 3)}}
30
+ <div class="release">
31
+ <div class="release-header">
32
+ <a
33
+ class="release-title"
34
+ href="{{release.html_url}}"
35
+ target="_blank"
36
+ rel="noopener noreferrer"
37
+ >{{release.name}}</a>
38
+ <span class="release-date">{{#moment
39
+ release.published_at "MMMM DD, yyyy"
40
+ }}{{/moment}}
41
+ </span>
42
+ </div>
43
+ <div class="release-body">
44
+ {{#if release.body}}
45
+ {{#markdown}}{{release.body}}{{/markdown}}
46
+ {{/if}}
47
+ </div>
48
+ </div>
49
+ {{/if}}
50
+ {{/each}}
51
+
52
+ {{#if (gt github.releases.length 6)}}
53
+ <div>
54
+ <a class="release-btn" href="/releases">
55
+ All Releases
56
+ <span>→</span>
57
+ </a>
58
+ </div>
59
+ {{/if}}
60
+ </div>
61
+ {{/if}}
62
+ {{/if}}
63
+ </article>
@@ -0,0 +1,3 @@
1
+ <header class="home-hero">
2
+ <img src="/logo.svg" alt="logo" />
3
+ </header>
@@ -0,0 +1,4 @@
1
+ <script src="/css/highlight/highlight.min.js"></script>
2
+ <script>
3
+ document.addEventListener('DOMContentLoaded', () => { hljs.highlightAll() });
4
+ </script>
@@ -0,0 +1,16 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ {{> header }}
5
+ <title>{{ siteTitle }}</title>
6
+ </head>
7
+
8
+ <body>
9
+ {{> landing/hero }}
10
+ <a class="github-fork-ribbon" href="https://github.com/{{ githubPath }}" data-ribbon="Fork me on GitHub" title="Fork me on GitHub">Fork me on GitHub</a>
11
+ {{> landing/content }}
12
+ {{> footer}}
13
+
14
+ {{> scripts }}
15
+ </body>
16
+ </html>
@@ -0,0 +1,45 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ {{> header }}
5
+ <title>{{siteTitle}} Releases</title>
6
+ </head>
7
+
8
+ <body>
9
+ {{> landing/hero }}
10
+ <a class="github-fork-ribbon" href="https://github.com/jaredwray/docula" data-ribbon="Fork me on GitHub" title="Fork me on GitHub">Fork me on GitHub</a>
11
+ <main class="home-container">
12
+ <div class="content-container versions-container">
13
+ <h2 class="home-title">Releases</h2>
14
+ {{#if github}}
15
+ {{#if github.releases}}
16
+ {{#each github.releases as |release|}}
17
+ <div class="release">
18
+ <div class="release-header">
19
+ <a
20
+ class="release-title"
21
+ href="{{release.html_url}}"
22
+ target="_blank"
23
+ rel="noopener noreferrer"
24
+ >{{release.name}}</a>
25
+ <span class="release-date">{{#moment
26
+ release.published_at "MMMM DD, yyyy"
27
+ }}{{/moment}}
28
+ </span>
29
+ </div>
30
+ <div class="release-body">
31
+ {{#if release.body}}
32
+ {{#markdown}}{{release.body}}{{/markdown}}
33
+ {{/if}}
34
+ </div>
35
+ </div>
36
+ {{/each}}
37
+ {{/if}}
38
+ {{/if}}
39
+ </div>
40
+ </main>
41
+ {{> footer}}
42
+
43
+ {{> scripts }}
44
+ </body>
45
+ </html>
package/bin/docula.js DELETED
@@ -1,7 +0,0 @@
1
- #!/usr/bin/env node
2
- import {Executable} from '../dist/index.js';
3
-
4
- const docula = new Executable();
5
-
6
- // eslint-disable-next-line unicorn/prefer-top-level-await, n/prefer-global/process
7
- docula.parseCLI(process).then();
package/dist/config.d.ts DELETED
@@ -1,21 +0,0 @@
1
- import type { PluginConfig, PluginConfigs, PluginName, Plugins } from './types/config.js';
2
- export declare class Config {
3
- originPath: string;
4
- outputPath: string;
5
- dataPath: string;
6
- templatePath: string;
7
- searchEngine: string;
8
- pluginConfig: PluginConfigs;
9
- plugins: Plugins;
10
- imagesPath: string;
11
- assetsPath: string;
12
- siteUrl: string;
13
- siteType: string;
14
- ajv: any;
15
- private readonly schema;
16
- constructor(path?: string);
17
- loadConfig(path: string): void;
18
- loadPlugins(name: PluginName, config: PluginConfig): void;
19
- checkConfigFile(path: string): boolean;
20
- }
21
- //# sourceMappingURL=config.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,EAAC,MAAM,mBAAmB,CAAC;AAGxF,qBAAa,MAAM;IAClB,UAAU,SAAU;IACpB,UAAU,SAAU;IACpB,QAAQ,SAAU;IAClB,YAAY,SAAc;IAC1B,YAAY,SAAc;IAE1B,YAAY,EAAE,aAAa,CAAuB;IAClD,OAAO,EAAE,OAAO,CAAM;IACtB,UAAU,SAAY;IACtB,UAAU,SAAS;IACnB,OAAO,SAAM;IACb,QAAQ,SAAM;IAEd,GAAG,MAAa;IAEhB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,IAAI,CAAC,EAAE,MAAM;IAczB,UAAU,CAAC,IAAI,EAAE,MAAM;IAwCvB,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY;IAWlD,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;CAGtC"}