@knowcode/doc-builder 1.9.29 → 1.9.31

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 (197) hide show
  1. package/assets/js/main.js +7 -0
  2. package/lib/core-builder.js +18 -1
  3. package/package.json +12 -2
  4. package/.claude/settings.local.json +0 -56
  5. package/CACHE-BUSTING-GUIDE.md +0 -82
  6. package/CLAUDE.md +0 -86
  7. package/CONTRIBUTING.md +0 -148
  8. package/GITHUB_SETUP.md +0 -203
  9. package/RELEASE-NOTES-1.7.5.md +0 -64
  10. package/Screenshot 2025-07-22 at 19.51.21.png +0 -0
  11. package/Screenshot 2025-07-26 at 17.06.49.png +0 -0
  12. package/add-user-clive.sql +0 -35
  13. package/add-user-lindsay-fixed.sql +0 -85
  14. package/add-user-lindsay.sql +0 -68
  15. package/add-user-pmorgan.sql +0 -35
  16. package/add-user-robbie.sql +0 -35
  17. package/add-wru-users.sql +0 -105
  18. package/debug-login.sql +0 -30
  19. package/doc-builder.config.js +0 -126
  20. package/doc-builder.config.js.backup.1753793768283 +0 -47
  21. package/doc-builder.config.js.backup.1753803964423 +0 -114
  22. package/doc-builder.config.js.backup.1753945707032 +0 -115
  23. package/doc-builder.config.js.backup.1754059241330 +0 -115
  24. package/doc-builder.config.js.backup.1754119567787 +0 -123
  25. package/doc-builder.config.js.backup.1754120048862 +0 -124
  26. package/doc-builder.config.js.backup.1754120529913 +0 -124
  27. package/doc-builder.config.js.backup.1754218469785 +0 -124
  28. package/doc-builder.config.js.backup.1754384764054 +0 -124
  29. package/doc-builder.config.js.backup.1754567425847 +0 -124
  30. package/doc-builder.config.js.backup.1754568137859 +0 -126
  31. package/doc-builder.config.js.backup.1754569388252 +0 -126
  32. package/doc-builder.config.js.backup.1754576694123 +0 -126
  33. package/doc-builder.config.js.backup.1755031374829 +0 -126
  34. package/doc-builder.config.js.backup.1755034500990 +0 -126
  35. package/grant-access.sql +0 -15
  36. package/html/11.png +0 -0
  37. package/html/404.html +0 -115
  38. package/html/README.html +0 -522
  39. package/html/Screenshot 2025-08-12 at 21.35.07.png +0 -0
  40. package/html/about-doc-builder.html +0 -491
  41. package/html/auth.js +0 -157
  42. package/html/claude-workflow-guide.html +0 -525
  43. package/html/css/notion-style.css +0 -2502
  44. package/html/documentation-index.html +0 -471
  45. package/html/guides/authentication-default-change.html +0 -370
  46. package/html/guides/authentication-guide.html +0 -509
  47. package/html/guides/cache-control-anti-pattern.html +0 -361
  48. package/html/guides/claude-workflow-guide.html +0 -1074
  49. package/html/guides/configuration-guide.html +0 -472
  50. package/html/guides/document-standards.html +0 -518
  51. package/html/guides/documentation-standards.html +0 -694
  52. package/html/guides/html-embedding-guide.html +0 -461
  53. package/html/guides/image-modal-guide.html +0 -515
  54. package/html/guides/next-steps-walkthrough.html +0 -638
  55. package/html/guides/phosphor-icons-guide.html +0 -584
  56. package/html/guides/private-directory-authentication-troubleshooting.html +0 -555
  57. package/html/guides/private-directory-authentication.html +0 -541
  58. package/html/guides/public-site-deployment.html +0 -431
  59. package/html/guides/search-engine-verification-guide.html +0 -542
  60. package/html/guides/seo-guide.html +0 -661
  61. package/html/guides/seo-optimization-guide.html +0 -887
  62. package/html/guides/supabase-auth-implementation-plan.html +0 -543
  63. package/html/guides/supabase-auth-integration-plan.html +0 -671
  64. package/html/guides/supabase-auth-setup-guide.html +0 -498
  65. package/html/guides/supabase-authentication-complete-guide.html +0 -866
  66. package/html/guides/troubleshooting-guide.html +0 -633
  67. package/html/guides/vercel-deployment-auth-setup.html +0 -337
  68. package/html/guides/windows-setup-guide.html +0 -859
  69. package/html/image-modal-test.html +0 -318
  70. package/html/index.html +0 -522
  71. package/html/js/auth.js +0 -157
  72. package/html/js/main.js +0 -1747
  73. package/html/launch/README.html +0 -297
  74. package/html/launch/bubble-plugin-specification.html +0 -933
  75. package/html/launch/go-to-market-strategy.html +0 -663
  76. package/html/launch/launch-announcements.html +0 -593
  77. package/html/login.html +0 -102
  78. package/html/logout.html +0 -18
  79. package/html/private/cache-control-anti-pattern.html +0 -429
  80. package/html/private/launch/README.html +0 -371
  81. package/html/private/launch/auth-cleanup-summary.html +0 -361
  82. package/html/private/launch/bubble-plugin-specification.html +0 -1007
  83. package/html/private/launch/go-to-market-strategy.html +0 -737
  84. package/html/private/launch/launch-announcements.html +0 -667
  85. package/html/private/launch/vercel-deployment-auth-setup.html +0 -417
  86. package/html/private/next-steps-walkthrough.html +0 -679
  87. package/html/private/supabase-auth-implementation-completed.html +0 -454
  88. package/html/private/supabase-auth-implementation-plan.html +0 -594
  89. package/html/private/supabase-auth-integration-plan.html +0 -704
  90. package/html/private/supabase-auth-setup-guide.html +0 -555
  91. package/html/private/test-private-doc.html +0 -302
  92. package/html/private/user-management-tooling.html +0 -601
  93. package/html/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
  94. package/html/prompts/beautiful-documentation-design.html +0 -784
  95. package/html/prompts/markdown-document-standards.html +0 -422
  96. package/html/prompts/project-rename-strategy-sasha-publish.html +0 -530
  97. package/html/robots.txt +0 -9
  98. package/html/sitemap.xml +0 -357
  99. package/html/test-questions/how-does-it-work%3F.html +0 -294
  100. package/html/test-questions/step-1%3A%20getting-started.html +0 -289
  101. package/html/test-questions/what-is-the-purpose.html +0 -293
  102. package/html/test-status.html +0 -281
  103. package/html/vercel-cli-setup-guide.html +0 -495
  104. package/html/vercel-first-time-setup-guide.html +0 -454
  105. package/html/vercel.json +0 -29
  106. package/html-static/11.png +0 -0
  107. package/html-static/404.html +0 -115
  108. package/html-static/README.html +0 -599
  109. package/html-static/Screenshot 2025-08-12 at 21.35.07.png +0 -0
  110. package/html-static/about-doc-builder.html +0 -568
  111. package/html-static/css/notion-style.css +0 -2502
  112. package/html-static/documentation-index.html +0 -548
  113. package/html-static/guides/authentication-default-change.html +0 -447
  114. package/html-static/guides/authentication-guide.html +0 -586
  115. package/html-static/guides/claude-workflow-guide.html +0 -1151
  116. package/html-static/guides/configuration-guide.html +0 -549
  117. package/html-static/guides/documentation-standards.html +0 -771
  118. package/html-static/guides/html-embedding-guide.html +0 -538
  119. package/html-static/guides/image-modal-guide.html +0 -592
  120. package/html-static/guides/phosphor-icons-guide.html +0 -661
  121. package/html-static/guides/private-directory-authentication-troubleshooting.html +0 -632
  122. package/html-static/guides/private-directory-authentication.html +0 -618
  123. package/html-static/guides/public-site-deployment.html +0 -508
  124. package/html-static/guides/search-engine-verification-guide.html +0 -619
  125. package/html-static/guides/seo-guide.html +0 -738
  126. package/html-static/guides/seo-optimization-guide.html +0 -964
  127. package/html-static/guides/supabase-authentication-complete-guide.html +0 -943
  128. package/html-static/guides/troubleshooting-guide.html +0 -710
  129. package/html-static/guides/windows-setup-guide.html +0 -936
  130. package/html-static/image-modal-test.html +0 -395
  131. package/html-static/index.html +0 -599
  132. package/html-static/js/main.js +0 -1747
  133. package/html-static/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
  134. package/html-static/prompts/beautiful-documentation-design.html +0 -861
  135. package/html-static/prompts/markdown-document-standards.html +0 -499
  136. package/html-static/prompts/project-rename-strategy-sasha-publish.html +0 -607
  137. package/html-static/robots.txt +0 -5
  138. package/html-static/sitemap.xml +0 -195
  139. package/html-static/test-questions/how-does-it-work%3F.html +0 -371
  140. package/html-static/test-questions/step-1%3A%20getting-started.html +0 -366
  141. package/html-static/test-questions/what-is-the-purpose.html +0 -370
  142. package/html-static/vercel-cli-setup-guide.html +0 -572
  143. package/html-static/vercel-first-time-setup-guide.html +0 -531
  144. package/manage-users.sql +0 -191
  145. package/migrate-to-domain-auth.sql +0 -47
  146. package/package/CACHE-BUSTING-GUIDE.md +0 -82
  147. package/package/CHANGELOG.md +0 -902
  148. package/package/README.md +0 -248
  149. package/package/assets/css/notion-style.css +0 -2211
  150. package/package/assets/js/auth.js +0 -67
  151. package/package/assets/js/main.js +0 -1565
  152. package/package/cli.js +0 -764
  153. package/package/index.js +0 -38
  154. package/package/knowcode-doc-builder-1.3.15.tgz +0 -0
  155. package/package/lib/builder.js +0 -32
  156. package/package/lib/config.js +0 -278
  157. package/package/lib/core-builder.js +0 -957
  158. package/package/lib/deploy.js +0 -497
  159. package/package/lib/dev-server.js +0 -96
  160. package/package/package.json +0 -34
  161. package/package/scripts/npx-runner.js +0 -27
  162. package/package/scripts/setup.js +0 -56
  163. package/package/test-cache-bust.sh +0 -43
  164. package/public-config.js +0 -22
  165. package/public-html/404.html +0 -115
  166. package/public-html/README.html +0 -149
  167. package/public-html/css/notion-style.css +0 -2036
  168. package/public-html/index.html +0 -149
  169. package/public-html/js/auth.js +0 -67
  170. package/public-html/js/main.js +0 -1485
  171. package/quick-test-commands.md +0 -40
  172. package/recordings/Screenshot 2025-07-24 at 18.22.01.png +0 -0
  173. package/recordings/mh-ls-22jul.txt +0 -2305
  174. package/screenshot.png +0 -0
  175. package/scripts/Screenshot 2025-07-23 at 15.39.41.png +0 -0
  176. package/setup-database-v2.sql +0 -53
  177. package/setup-database.sql +0 -41
  178. package/test-auth-config.js +0 -17
  179. package/test-cache-bust.sh +0 -43
  180. package/test-docs/README.md +0 -39
  181. package/test-html/404.html +0 -115
  182. package/test-html/README.html +0 -172
  183. package/test-html/auth.js +0 -97
  184. package/test-html/css/notion-style.css +0 -2036
  185. package/test-html/index.html +0 -172
  186. package/test-html/js/auth.js +0 -97
  187. package/test-html/js/main.js +0 -1485
  188. package/test-html/login.html +0 -102
  189. package/test-html/logout.html +0 -18
  190. package/update-domain.sql +0 -9
  191. package/user-access-view.sql +0 -49
  192. package/user-management/README.md +0 -301
  193. package/user-management/add-users.sh +0 -776
  194. package/user-management/create-user.js +0 -65
  195. package/user-management/users.txt +0 -15
  196. package/view-all-users.sql +0 -40
  197. package/wru-auth-config.js +0 -17
package/assets/js/main.js CHANGED
@@ -1473,6 +1473,13 @@ function generateBreadcrumbs() {
1473
1473
  const buildDate = breadcrumbContainer.getAttribute('data-build-date');
1474
1474
  const docBuilderVersion = breadcrumbContainer.getAttribute('data-doc-builder-version');
1475
1475
 
1476
+ // For static builds, check if content is already pre-rendered
1477
+ if (isStaticBuild && breadcrumbContainer.querySelector('.breadcrumbs-content')) {
1478
+ // Content is pre-rendered, just ensure exportToPDF is available globally
1479
+ window.exportToPDF = exportToPDF;
1480
+ return; // Don't override pre-rendered content
1481
+ }
1482
+
1476
1483
  // Decode the URL to handle special characters and spaces
1477
1484
  const currentPath = decodeURIComponent(window.location.pathname);
1478
1485
  let pathSegments = currentPath.split('/').filter(segment => segment !== '');
@@ -779,7 +779,24 @@ ${seoTags}
779
779
  minute: '2-digit',
780
780
  timeZone: 'UTC'
781
781
  })} UTC" data-doc-builder-version="${docBuilderVersion}"` : ''}>
782
- <!-- Breadcrumbs will be generated by JavaScript -->
782
+ ${config.isStaticOutput ? `
783
+ <!-- Pre-rendered breadcrumb content for static builds -->
784
+ <div class="breadcrumbs-content breadcrumbs-homepage">
785
+ <div class="breadcrumbs-right">
786
+ <span class="breadcrumb-date" title="Built with doc-builder v${docBuilderVersion}">Last updated: ${new Date().toLocaleDateString('en-US', {
787
+ year: 'numeric',
788
+ month: 'short',
789
+ day: 'numeric',
790
+ hour: '2-digit',
791
+ minute: '2-digit',
792
+ timeZone: 'UTC'
793
+ })} UTC</span>
794
+ <button class="breadcrumb-pdf-btn" onclick="if(typeof exportToPDF !== 'undefined') exportToPDF(); else window.print();" title="Export to PDF" aria-label="Export to PDF">
795
+ <i class="fas fa-file-pdf"></i>
796
+ </button>
797
+ </div>
798
+ </div>
799
+ ` : '<!-- Breadcrumbs will be generated by JavaScript -->'}
783
800
  </nav>
784
801
 
785
802
  <!-- Main Content -->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowcode/doc-builder",
3
- "version": "1.9.29",
3
+ "version": "1.9.31",
4
4
  "description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
5
5
  "main": "index.js",
6
6
  "bin": {
@@ -29,7 +29,6 @@
29
29
  },
30
30
  "homepage": "https://github.com/wapdat/doc-builder#readme",
31
31
  "dependencies": {
32
- "@knowcode/doc-builder": "^1.4.21",
33
32
  "@supabase/supabase-js": "^2.39.0",
34
33
  "chalk": "^4.1.2",
35
34
  "commander": "^11.0.0",
@@ -40,6 +39,17 @@
40
39
  "prompts": "^2.4.2",
41
40
  "semver": "^7.7.2"
42
41
  },
42
+ "files": [
43
+ "cli.js",
44
+ "index.js",
45
+ "lib/**/*",
46
+ "assets/**/*",
47
+ "scripts/**/*",
48
+ "templates/**/*",
49
+ "README.md",
50
+ "LICENSE",
51
+ "CHANGELOG.md"
52
+ ],
43
53
  "engines": {
44
54
  "node": ">=14.0.0"
45
55
  }
@@ -1,56 +0,0 @@
1
- {
2
- "permissions": {
3
- "allow": [
4
- "Bash(node:*)",
5
- "Bash(git add:*)",
6
- "Bash(git commit:*)",
7
- "Bash(npm version:*)",
8
- "Bash(npm pack)",
9
- "Bash(cat:*)",
10
- "Bash(rm:*)",
11
- "Bash(npm publish:*)",
12
- "Bash(git tag:*)",
13
- "Bash(git push:*)",
14
- "Bash(git pull:*)",
15
- "Bash(git rebase:*)",
16
- "Bash(npm info:*)",
17
- "Bash(npx:*)",
18
- "Bash(grep:*)",
19
- "Bash(npm cache clean:*)",
20
- "Bash(ls:*)",
21
- "Bash(npm run build:*)",
22
- "Bash(npm view:*)",
23
- "Bash(npm:*)",
24
- "Bash(vercel project:*)",
25
- "Bash(vercel alias:*)",
26
- "Bash(find:*)",
27
- "Bash(diff:*)",
28
- "Bash(git log:*)",
29
- "Bash(mkdir:*)",
30
- "Bash(cp:*)",
31
- "Bash(./publish.sh)",
32
- "Bash(mv:*)",
33
- "WebFetch(domain:convert-to-markdown.vercel.app)",
34
- "Bash(pkill:*)",
35
- "Bash(curl:*)",
36
- "Bash(./cli.js build:*)",
37
- "Bash(./cli.js deploy:*)",
38
- "Bash(./add-users.sh:*)",
39
- "Bash(python3:*)",
40
- "Bash(chmod:*)",
41
- "Bash(supabase auth:*)",
42
- "Bash(supabase:*)",
43
- "Bash(DEBUG=1 ./user-management/add-users.sh add wru-bid-analysis.vercel.app lindsay@knowcode.tech)",
44
- "Bash(./user-management/add-users.sh:*)",
45
- "Bash(DEBUG=1 ./add-users.sh add wru-bid-analysis.vercel.app lindsay@knowcode.tech)",
46
- "Bash(brew upgrade:*)",
47
- "Bash(psql:*)",
48
- "Bash(open /Users/lindsaysmith/Documents/lambda1.nosync/doc-builder/html/image-modal-test.html)",
49
- "WebFetch(domain:nudge-campaign.vercel.app)",
50
- "WebFetch(domain:mermaid.js.org)",
51
- "Bash(open html/test-mermaid-enhanced.html)",
52
- "Bash(open:*)"
53
- ],
54
- "deny": []
55
- }
56
- }
@@ -1,82 +0,0 @@
1
- # Cache Busting Guide for @knowcode/doc-builder
2
-
3
- If you're not seeing updates after upgrading to a new version, it's likely due to caching. Follow these steps:
4
-
5
- ## 1. Clean Everything Locally
6
-
7
- ```bash
8
- # Remove old build artifacts
9
- rm -rf html/
10
-
11
- # Clear npm cache
12
- npm cache clean --force
13
-
14
- # Remove node_modules and reinstall
15
- rm -rf node_modules
16
- npm install
17
-
18
- # Make sure you have the latest version
19
- npm install @knowcode/doc-builder@latest
20
- ```
21
-
22
- ## 2. Rebuild with Fresh Files
23
-
24
- ```bash
25
- # Build fresh documentation
26
- npx @knowcode/doc-builder build
27
- ```
28
-
29
- ## 3. Deploy with Force Flag
30
-
31
- ```bash
32
- # Force Vercel to ignore cache
33
- vercel --prod --force
34
- ```
35
-
36
- ## 4. Clear Browser Cache
37
-
38
- - **Chrome/Edge**: Cmd+Shift+R (Mac) or Ctrl+Shift+R (Windows)
39
- - **Firefox**: Cmd+Shift+R (Mac) or Ctrl+Shift+R (Windows)
40
- - **Safari**: Cmd+Option+R
41
- - Or use Incognito/Private browsing mode
42
-
43
- ## 5. Clear Vercel/CDN Cache (if applicable)
44
-
45
- If using Vercel:
46
- 1. Go to your project dashboard
47
- 2. Settings → Functions → Purge Cache
48
- 3. Or redeploy with a different domain temporarily
49
-
50
- ## 6. Add Cache Busting to Your Build
51
-
52
- Edit your `doc-builder.config.js` to add version query strings:
53
-
54
- ```javascript
55
- module.exports = {
56
- // ... other config
57
- cacheBust: true, // This will add ?v=timestamp to CSS/JS files
58
- };
59
- ```
60
-
61
- ## Common Issues
62
-
63
- - **"I updated but nothing changed"** - It's cache. Follow all steps above.
64
- - **"Tooltips still don't work"** - Clear browser cache and check console for errors
65
- - **"Spacing is still wrong"** - The CSS is cached. Hard refresh the page.
66
-
67
- ## Verify You Have The Right Version
68
-
69
- Check the version in your package.json:
70
- ```bash
71
- npm list @knowcode/doc-builder
72
- ```
73
-
74
- Should show: `@knowcode/doc-builder@1.3.13` or higher.
75
-
76
- ## Still Not Working?
77
-
78
- 1. Open browser DevTools
79
- 2. Go to Network tab
80
- 3. Check "Disable cache" checkbox
81
- 4. Refresh the page
82
- 5. Look at the CSS/JS files being loaded - they should not show "(from cache)"
package/CLAUDE.md DELETED
@@ -1,86 +0,0 @@
1
- # CLAUDE.md - @knowcode/doc-builder
2
-
3
- This file provides comprehensive guidance for Claude Code when working with the @knowcode/doc-builder project - a Notion-inspired documentation generator that converts markdown files to beautiful static HTML sites with Vercel deployment support.
4
-
5
- ## Project Overview
6
-
7
- **Name**: @knowcode/doc-builder
8
- **Version**: 1.4.3
9
- **Purpose**: Transform markdown documentation into beautiful, searchable static HTML sites with a Notion-inspired design
10
- **NPM Package**: Published at https://www.npmjs.com/package/@knowcode/doc-builder
11
- **GitHub Repository**: https://github.com/wapdat/doc-builder
12
-
13
- ### Key Features
14
- - 📝 **Markdown to HTML conversion** with syntax highlighting and mermaid diagram support
15
- - 🎨 **Notion-inspired design** with dark mode support
16
- - 🚀 **One-command Vercel deployment** with zero configuration
17
- - 🔍 **Auto-generated navigation** from folder structure
18
- - 🔐 **Optional authentication** for private documentation
19
- - 📊 **Mermaid diagram support** out of the box
20
- - 📱 **Fully responsive** design
21
- - 🔧 **Zero configuration** - works with sensible defaults
22
-
23
- ## Emoji to Icon Mapping
24
-
25
- The project includes automatic emoji to Phosphor icon conversion in markdown files. To add new emoji mappings:
26
-
27
- ### Adding New Emoji Mappings
28
-
29
- 1. **Location**: Edit `lib/emoji-mapper.js`
30
- 2. **Structure**: Add entries to the `emojiToPhosphor` object
31
- 3. **Format**: `'🏷️': '<i class="ph ph-tag" aria-label="tag"></i>'`
32
-
33
- ### Guidelines for New Mappings
34
-
35
- - **Categorization**: Place emojis in appropriate sections (UI & Design, Actions & Navigation, etc.)
36
- - **Icon Selection**: Use appropriate Phosphor icons from https://phosphoricons.com
37
- - **Aria Labels**: Include descriptive aria-label attributes for accessibility
38
- - **Semantic Matching**: Choose icons that best represent the emoji's meaning
39
-
40
- ### Example Addition
41
-
42
- ```javascript
43
- // In the UI & Design section
44
- '🏷️': '<i class="ph ph-tag" aria-label="tag"></i>',
45
- '👁️': '<i class="ph ph-eye" aria-label="view"></i>',
46
- ```
47
-
48
- ### Available Phosphor Icon Weights
49
-
50
- The system supports different icon weights via configuration:
51
- - `regular` (default)
52
- - `thin`
53
- - `light`
54
- - `bold`
55
- - `fill`
56
- - `duotone`
57
-
58
- ## Documentation Guidelines
59
-
60
- - For this project documentation, do not include in each document:
61
- - Generated timestamp
62
- - Status field
63
- - Verification status
64
- - We do not want these metadata fields in the project documentation
65
-
66
- ## NPM Publishing
67
-
68
- ### Easy Publishing Workflow
69
-
70
- The simple way to publish to npm:
71
-
72
- 1. **Update version** in `package.json`
73
- 2. **Commit changes**: `git add . && git commit -m "feat: description"`
74
- 3. **Publish**: `npm publish`
75
-
76
- ### Prerequisites
77
-
78
- - Logged into npm: `npm whoami`
79
- - Version not already published
80
- - Working directory clean
81
-
82
- ### Notes
83
-
84
- - Use `npm publish` directly instead of the interactive script
85
- - No need for complex automation - npm handles everything
86
- - Package automatically includes all necessary files via package.json
package/CONTRIBUTING.md DELETED
@@ -1,148 +0,0 @@
1
- # Contributing to Doc Builder
2
-
3
- First off, thank you for considering contributing to Doc Builder! It's people like you that make Doc Builder such a great tool.
4
-
5
- ## Code of Conduct
6
-
7
- By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
8
-
9
- ## How Can I Contribute?
10
-
11
- ### Reporting Bugs
12
-
13
- Before creating bug reports, please check existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:
14
-
15
- * **Use a clear and descriptive title**
16
- * **Describe the exact steps to reproduce the problem**
17
- * **Provide specific examples to demonstrate the steps**
18
- * **Describe the behavior you observed and expected**
19
- * **Include screenshots if relevant**
20
- * **Include your environment details** (OS, Node.js version, npm version)
21
-
22
- ### Suggesting Enhancements
23
-
24
- Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:
25
-
26
- * **Use a clear and descriptive title**
27
- * **Provide a detailed description of the suggested enhancement**
28
- * **Provide specific examples to demonstrate how it would work**
29
- * **Describe the current behavior and expected behavior**
30
- * **Explain why this enhancement would be useful**
31
-
32
- ### Your First Code Contribution
33
-
34
- Unsure where to begin? You can start by looking through these issues:
35
-
36
- * `good first issue` - issues which should only require a few lines of code
37
- * `help wanted` - issues which need extra attention
38
-
39
- ### Pull Requests
40
-
41
- 1. Fork the repo and create your branch from `main`
42
- 2. If you've added code that should be tested, add tests
43
- 3. If you've changed APIs, update the documentation
44
- 4. Ensure the test suite passes
45
- 5. Make sure your code follows the existing style
46
- 6. Issue that pull request!
47
-
48
- ## Development Process
49
-
50
- 1. **Setup your environment**
51
- ```bash
52
- git clone https://github.com/YOUR_USERNAME/doc-builder.git
53
- cd doc-builder
54
- npm install
55
- ```
56
-
57
- 2. **Create a branch**
58
- ```bash
59
- git checkout -b feature/your-feature-name
60
- ```
61
-
62
- 3. **Make your changes**
63
- - Write code
64
- - Add tests if applicable
65
- - Update documentation
66
-
67
- 4. **Test your changes**
68
- ```bash
69
- npm test
70
- npm run build
71
- npm run dev
72
- ```
73
-
74
- 5. **Commit your changes**
75
- ```bash
76
- git add .
77
- git commit -m "feat: add amazing feature"
78
- ```
79
-
80
- We follow [Conventional Commits](https://www.conventionalcommits.org/):
81
- - `feat:` new feature
82
- - `fix:` bug fix
83
- - `docs:` documentation changes
84
- - `style:` formatting, missing semicolons, etc
85
- - `refactor:` code change that neither fixes a bug nor adds a feature
86
- - `test:` adding missing tests
87
- - `chore:` maintain
88
-
89
- 6. **Push to your fork**
90
- ```bash
91
- git push origin feature/your-feature-name
92
- ```
93
-
94
- 7. **Open a Pull Request**
95
-
96
- ## Style Guide
97
-
98
- ### JavaScript Style Guide
99
-
100
- * Use ES6+ features where appropriate
101
- * 2 spaces for indentation
102
- * Use semicolons
103
- * Use `const` and `let`, avoid `var`
104
- * Use meaningful variable names
105
- * Add comments for complex logic
106
-
107
- ### Documentation Style Guide
108
-
109
- * Use Markdown for all documentation
110
- * Include code examples where relevant
111
- * Keep line length to 80 characters where possible
112
- * Use present tense ("Add feature" not "Added feature")
113
-
114
- ## Testing
115
-
116
- * Write tests for new features
117
- * Ensure all tests pass before submitting PR
118
- * Aim for high code coverage
119
- * Test edge cases
120
-
121
- ## Project Structure
122
-
123
- ```
124
- doc-builder/
125
- ├── assets/ # Static assets
126
- ├── lib/ # Core library code
127
- ├── scripts/ # Build and utility scripts
128
- ├── templates/ # HTML templates
129
- ├── test/ # Test files
130
- ├── docs/ # Documentation
131
- └── cli.js # CLI entry point
132
- ```
133
-
134
- ## Release Process
135
-
136
- Maintainers will handle releases, but for reference:
137
-
138
- 1. Update version in `package.json`
139
- 2. Update `CHANGELOG.md`
140
- 3. Commit changes
141
- 4. Tag release
142
- 5. Push to npm
143
-
144
- ## Questions?
145
-
146
- Feel free to open an issue with your question or reach out to the maintainers.
147
-
148
- Thank you for contributing! 🎉
package/GITHUB_SETUP.md DELETED
@@ -1,203 +0,0 @@
1
- # GitHub Repository Setup Instructions
2
-
3
- This guide will walk you through setting up the doc-builder project on GitHub.
4
-
5
- ## Prerequisites
6
-
7
- - GitHub account
8
- - Git installed locally
9
- - Command line access
10
-
11
- ## Step 1: Create GitHub Repository
12
-
13
- 1. Go to https://github.com/new
14
- 2. Repository settings:
15
- - **Repository name**: `doc-builder`
16
- - **Description**: `Transform markdown into beautiful documentation sites with one-command Vercel deployment`
17
- - **Public** repository (for open source)
18
- - **DO NOT** initialize with README, .gitignore, or license (we already have these)
19
-
20
- 3. Click "Create repository"
21
-
22
- ## Step 2: Update Local Git Configuration
23
-
24
- First, let's check the current remote:
25
-
26
- ```bash
27
- git remote -v
28
- ```
29
-
30
- You'll see it points to a local directory. We need to change this to GitHub.
31
-
32
- ## Step 3: Add GitHub as Remote
33
-
34
- Since your repository is at https://github.com/wapdat/doc-builder:
35
-
36
- ```bash
37
- # Remove the existing remote
38
- git remote remove origin
39
-
40
- # Add GitHub as the new origin
41
- git remote add origin https://github.com/wapdat/doc-builder.git
42
-
43
- # Verify the change
44
- git remote -v
45
- ```
46
-
47
- ## Step 4: Push to GitHub
48
-
49
- ```bash
50
- # Push all branches and tags
51
- git push -u origin main
52
- git push --tags
53
- ```
54
-
55
- ## Step 5: Configure Repository Settings
56
-
57
- On GitHub, go to Settings and configure:
58
-
59
- ### General Settings
60
- - **Features**: Enable Issues, Projects, and Discussions
61
- - **Pull Requests**: Allow merge commits, squash merging, and rebase merging
62
-
63
- ### Branch Protection (Settings → Branches)
64
- For the `main` branch:
65
- - [ ] Require pull request reviews before merging
66
- - [ ] Dismiss stale pull request approvals
67
- - [ ] Require status checks to pass
68
- - [ ] Include administrators
69
-
70
- ### Pages (optional, for documentation)
71
- - Source: Deploy from a branch
72
- - Branch: main
73
- - Folder: /docs
74
-
75
- ### Topics
76
- Add these topics to help people discover your project:
77
- - `documentation`
78
- - `markdown`
79
- - `static-site-generator`
80
- - `vercel`
81
- - `notion`
82
- - `developer-tools`
83
- - `nodejs`
84
- - `npm-package`
85
-
86
- ## Step 6: Add Badges to README
87
-
88
- Update your README.md to include GitHub badges:
89
-
90
- ```markdown
91
- [![npm version](https://img.shields.io/npm/v/@knowcode/doc-builder)](https://www.npmjs.com/package/@knowcode/doc-builder)
92
- [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
93
- [![GitHub stars](https://img.shields.io/github/stars/wapdat/doc-builder)](https://github.com/wapdat/doc-builder/stargazers)
94
- [![GitHub issues](https://img.shields.io/github/issues/wapdat/doc-builder)](https://github.com/wapdat/doc-builder/issues)
95
- ```
96
-
97
- ## Step 7: Create Initial Release
98
-
99
- 1. Go to https://github.com/wapdat/doc-builder/releases
100
- 2. Click "Create a new release"
101
- 3. Tag version: `v1.5.21`
102
- 4. Release title: `v1.5.21 - Stable Release`
103
- 5. Description:
104
- ```markdown
105
- ## Doc Builder v1.5.21
106
-
107
- First public release of Doc Builder on GitHub!
108
-
109
- ### Features
110
- - ✨ Notion-inspired design
111
- - 🚀 One-command Vercel deployment
112
- - 🔍 Built-in search functionality
113
- - 🌓 Dark mode support
114
- - 📊 Mermaid diagram integration
115
- - 🔐 Password protection option
116
-
117
- ### Installation
118
- ```bash
119
- npm install -g @knowcode/doc-builder
120
- ```
121
-
122
- ### Quick Start
123
- ```bash
124
- npx @knowcode/doc-builder@latest deploy
125
- ```
126
- ```
127
- 6. Click "Publish release"
128
-
129
- ## Step 8: Set Up GitHub Actions (Optional)
130
-
131
- Create `.github/workflows/npm-publish.yml`:
132
-
133
- ```yaml
134
- name: Publish to NPM
135
-
136
- on:
137
- release:
138
- types: [created]
139
-
140
- jobs:
141
- publish:
142
- runs-on: ubuntu-latest
143
- steps:
144
- - uses: actions/checkout@v4
145
- - uses: actions/setup-node@v4
146
- with:
147
- node-version: '20'
148
- registry-url: 'https://registry.npmjs.org'
149
- - run: npm ci
150
- - run: npm test
151
- - run: npm publish
152
- env:
153
- NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
154
- ```
155
-
156
- To use this:
157
- 1. Get npm token from https://www.npmjs.com/settings/YOUR_NPM_USERNAME/tokens
158
- 2. Add as secret in GitHub: Settings → Secrets → Actions → New repository secret
159
- 3. Name: `NPM_TOKEN`
160
-
161
- ## Step 9: Update Package.json
162
-
163
- Add GitHub repository info to package.json:
164
-
165
- ```json
166
- "repository": {
167
- "type": "git",
168
- "url": "git+https://github.com/wapdat/doc-builder.git"
169
- },
170
- "bugs": {
171
- "url": "https://github.com/wapdat/doc-builder/issues"
172
- },
173
- "homepage": "https://github.com/wapdat/doc-builder#readme"
174
- ```
175
-
176
- ## Step 10: Announce the Repository
177
-
178
- Once everything is set up:
179
-
180
- 1. Update the demo site to link to GitHub
181
- 2. Update npm package to include repository link
182
- 3. Share on social media
183
- 4. Submit to awesome lists
184
- 5. Post in relevant communities
185
-
186
- ## Maintenance Tips
187
-
188
- - Respond to issues promptly
189
- - Review pull requests within a week
190
- - Keep dependencies updated
191
- - Tag releases consistently
192
- - Maintain a clear roadmap
193
- - Acknowledge contributors
194
-
195
- ## Next Steps
196
-
197
- 1. [ ] Create a GitHub Project board for roadmap
198
- 2. [ ] Set up GitHub Discussions for community
199
- 3. [ ] Add GitHub Sponsors if desired
200
- 4. [ ] Create GitHub Wiki for extended docs
201
- 5. [ ] Set up automated testing with GitHub Actions
202
-
203
- The repository is configured for https://github.com/wapdat/doc-builder