@knowcode/doc-builder 1.6.5 → 1.7.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.
@@ -319,7 +319,7 @@ pre code {
319
319
  background: var(--color-bg-secondary);
320
320
  border-right: 1px solid var(--color-border-default);
321
321
  overflow: hidden;
322
- transition: width var(--duration-normal);
322
+ transition: width var(--duration-normal), transform 0.3s ease, margin-left 0.3s ease;
323
323
  min-width: 200px;
324
324
  max-width: 500px;
325
325
  user-select: none;
@@ -330,6 +330,14 @@ pre code {
330
330
  height: 100%;
331
331
  }
332
332
 
333
+ /* Desktop sidebar closed state */
334
+ @media (min-width: 769px) {
335
+ .sidebar.closed {
336
+ transform: translateX(-100%);
337
+ margin-left: calc(var(--sidebar-width) * -1);
338
+ }
339
+ }
340
+
333
341
  /* Banner adjustment no longer needed with relative positioning */
334
342
 
335
343
 
@@ -1958,31 +1966,33 @@ tr:hover {
1958
1966
  /* Phosphor Icons Alignment */
1959
1967
  .ph {
1960
1968
  display: inline-block;
1961
- vertical-align: text-top;
1962
- line-height: 0.8;
1969
+ vertical-align: middle;
1970
+ line-height: 1;
1963
1971
  position: relative;
1964
- top: 0.2em; /* Push down to align with x-height of text */
1972
+ top: -0.05em; /* Slight upward adjustment for better baseline alignment */
1965
1973
  }
1966
1974
 
1967
1975
  /* Ensure icons in headings are properly aligned */
1968
1976
  h1 .ph, h2 .ph, h3 .ph, h4 .ph, h5 .ph, h6 .ph {
1969
1977
  font-size: 0.85em; /* Slightly smaller in headings */
1970
- line-height: 0.8;
1971
- top: 0.15em;
1978
+ line-height: 1;
1979
+ top: -0.05em;
1972
1980
  }
1973
1981
 
1974
1982
  /* Icons in lists need special handling */
1975
1983
  li .ph {
1976
1984
  margin-right: 0.3em;
1977
- font-size: 1.05em;
1978
- line-height: 0.85;
1979
- top: 0.15em;
1985
+ font-size: 1.1em;
1986
+ line-height: 1;
1987
+ vertical-align: middle;
1988
+ top: -0.05em;
1980
1989
  }
1981
1990
 
1982
1991
  /* Icons in tables */
1983
1992
  td .ph, th .ph {
1984
- line-height: 0.8;
1985
- top: 0.2em;
1993
+ line-height: 1;
1994
+ vertical-align: middle;
1995
+ top: -0.05em;
1986
1996
  }
1987
1997
 
1988
1998
  /* Icons in navigation */
@@ -1995,7 +2005,7 @@ td .ph, th .ph {
1995
2005
 
1996
2006
  /* Icon size adjustments for better visual balance */
1997
2007
  .content p .ph {
1998
- font-size: 1.05em; /* Slightly larger than text for visual balance */
2008
+ font-size: 1.1em; /* Slightly larger than text for visual balance */
1999
2009
  }
2000
2010
 
2001
2011
  /* Special handling for inline code with icons */
@@ -2008,5 +2018,5 @@ code .ph {
2008
2018
 
2009
2019
  /* Additional fine-tuning for specific contexts */
2010
2020
  .content-inner .ph {
2011
- transform: translateY(0.05em); /* Very slight additional adjustment */
2021
+ /* Remove the transform as we're now using consistent vertical-align: middle */
2012
2022
  }
package/assets/js/main.js CHANGED
@@ -494,6 +494,14 @@ function updateThemeIcon(theme) {
494
494
  const menuToggle = document.getElementById('menu-toggle');
495
495
  const sidebar = document.querySelector('.sidebar');
496
496
 
497
+ // Set initial menu state based on configuration
498
+ if (sidebar && window.innerWidth > 768) {
499
+ const menuDefaultOpen = window.docBuilderConfig?.features?.menuDefaultOpen !== false;
500
+ if (!menuDefaultOpen) {
501
+ sidebar.classList.add('closed');
502
+ }
503
+ }
504
+
497
505
  // Create overlay element for mobile
498
506
  let overlay = document.querySelector('.sidebar-overlay');
499
507
  if (!overlay && window.innerWidth <= 768) {
@@ -504,7 +512,13 @@ if (!overlay && window.innerWidth <= 768) {
504
512
 
505
513
  if (menuToggle) {
506
514
  menuToggle.addEventListener('click', () => {
507
- sidebar.classList.toggle('open');
515
+ if (window.innerWidth <= 768) {
516
+ // Mobile: toggle 'open' class
517
+ sidebar.classList.toggle('open');
518
+ } else {
519
+ // Desktop: toggle 'closed' class
520
+ sidebar.classList.toggle('closed');
521
+ }
508
522
  if (overlay) {
509
523
  overlay.classList.toggle('active');
510
524
  }
@@ -1278,6 +1292,10 @@ function exportToPDF() {
1278
1292
 
1279
1293
  // Add PDF export button functionality
1280
1294
  function addPDFExportButton() {
1295
+ // Check configuration - default to true if not set
1296
+ const showPdfDownload = window.docBuilderConfig?.features?.showPdfDownload !== false;
1297
+ if (!showPdfDownload) return;
1298
+
1281
1299
  const headerActions = document.querySelector('.header-actions');
1282
1300
  if (headerActions) {
1283
1301
  const pdfButton = document.createElement('button');
package/cli.js CHANGED
@@ -72,6 +72,8 @@ program
72
72
  .option('--legacy', 'use legacy mode for backward compatibility')
73
73
  .option('--no-auth', 'disable authentication even if configured')
74
74
  .option('--no-changelog', 'disable automatic changelog generation')
75
+ .option('--no-pdf', 'hide PDF download icon in header')
76
+ .option('--menu-closed', 'start with navigation menu closed')
75
77
  .addHelpText('after', `
76
78
  ${chalk.yellow('Examples:')}
77
79
  ${chalk.gray('$')} doc-builder build ${chalk.gray('# Build with defaults')}
package/html/README.html CHANGED
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T11:58:38.004Z",
67
- "dateModified": "2025-07-23T11:58:38.004Z",
66
+ "datePublished": "2025-07-24T08:19:52.195Z",
67
+ "dateModified": "2025-07-24T08:19:52.195Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/README.html"
@@ -97,7 +97,7 @@
97
97
 
98
98
  <div class="header-actions">
99
99
  <div class="deployment-info">
100
- <span class="deployment-date" title="Built with doc-builder v1.6.4">Last updated: Jul 23, 2025, 11:58 AM UTC</span>
100
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
101
101
  </div>
102
102
 
103
103
 
@@ -148,7 +148,6 @@
148
148
  <div class="nav-content" >
149
149
  <a href="/README.html" class="nav-item active" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
150
150
  <a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
151
- <a href="/test-emojis.html" class="nav-item" data-tooltip="🆘 SOS/Emergency - Should convert to first-aid icon 🚨 Alert - Already working (siren icon) Money and Finance."><i class="fas fa-file-alt"></i> Test Emojis</a>
152
151
  <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
153
152
  <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
154
153
  <div class="nav-section" data-level="1">
@@ -295,7 +294,7 @@ module.exports = {
295
294
  siteDescription: &#39;Transform markdown into beautiful documentation&#39;,
296
295
  docsDir: &#39;docs&#39;,
297
296
  outputDir: &#39;html&#39;,
298
- favicon: &#39;<i class="ph ph-sparkle" aria-label="special"></i>&#39; // Can be emoji or path to image
297
+ favicon: &#39;✨&#39; // Can be emoji or path to image
299
298
  };
300
299
  </code></pre>
301
300
  <p><em>The CLI creates and updates this for you</em></p>
@@ -423,6 +422,15 @@ docBuilder.build({
423
422
  </div>
424
423
 
425
424
  <!-- Scripts -->
425
+ <script>
426
+ // Pass configuration to frontend
427
+ window.docBuilderConfig = {
428
+ features: {
429
+ showPdfDownload: true,
430
+ menuDefaultOpen: true
431
+ }
432
+ };
433
+ </script>
426
434
  <script src="/js/main.js"></script>
427
435
 
428
436
  </body>
@@ -319,7 +319,7 @@ pre code {
319
319
  background: var(--color-bg-secondary);
320
320
  border-right: 1px solid var(--color-border-default);
321
321
  overflow: hidden;
322
- transition: width var(--duration-normal);
322
+ transition: width var(--duration-normal), transform 0.3s ease, margin-left 0.3s ease;
323
323
  min-width: 200px;
324
324
  max-width: 500px;
325
325
  user-select: none;
@@ -330,6 +330,14 @@ pre code {
330
330
  height: 100%;
331
331
  }
332
332
 
333
+ /* Desktop sidebar closed state */
334
+ @media (min-width: 769px) {
335
+ .sidebar.closed {
336
+ transform: translateX(-100%);
337
+ margin-left: calc(var(--sidebar-width) * -1);
338
+ }
339
+ }
340
+
333
341
  /* Banner adjustment no longer needed with relative positioning */
334
342
 
335
343
 
@@ -1958,31 +1966,33 @@ tr:hover {
1958
1966
  /* Phosphor Icons Alignment */
1959
1967
  .ph {
1960
1968
  display: inline-block;
1961
- vertical-align: text-top;
1962
- line-height: 0.8;
1969
+ vertical-align: middle;
1970
+ line-height: 1;
1963
1971
  position: relative;
1964
- top: 0.2em; /* Push down to align with x-height of text */
1972
+ top: -0.05em; /* Slight upward adjustment for better baseline alignment */
1965
1973
  }
1966
1974
 
1967
1975
  /* Ensure icons in headings are properly aligned */
1968
1976
  h1 .ph, h2 .ph, h3 .ph, h4 .ph, h5 .ph, h6 .ph {
1969
1977
  font-size: 0.85em; /* Slightly smaller in headings */
1970
- line-height: 0.8;
1971
- top: 0.15em;
1978
+ line-height: 1;
1979
+ top: -0.05em;
1972
1980
  }
1973
1981
 
1974
1982
  /* Icons in lists need special handling */
1975
1983
  li .ph {
1976
1984
  margin-right: 0.3em;
1977
- font-size: 1.05em;
1978
- line-height: 0.85;
1979
- top: 0.15em;
1985
+ font-size: 1.1em;
1986
+ line-height: 1;
1987
+ vertical-align: middle;
1988
+ top: -0.05em;
1980
1989
  }
1981
1990
 
1982
1991
  /* Icons in tables */
1983
1992
  td .ph, th .ph {
1984
- line-height: 0.8;
1985
- top: 0.2em;
1993
+ line-height: 1;
1994
+ vertical-align: middle;
1995
+ top: -0.05em;
1986
1996
  }
1987
1997
 
1988
1998
  /* Icons in navigation */
@@ -1995,7 +2005,7 @@ td .ph, th .ph {
1995
2005
 
1996
2006
  /* Icon size adjustments for better visual balance */
1997
2007
  .content p .ph {
1998
- font-size: 1.05em; /* Slightly larger than text for visual balance */
2008
+ font-size: 1.1em; /* Slightly larger than text for visual balance */
1999
2009
  }
2000
2010
 
2001
2011
  /* Special handling for inline code with icons */
@@ -2008,5 +2018,5 @@ code .ph {
2008
2018
 
2009
2019
  /* Additional fine-tuning for specific contexts */
2010
2020
  .content-inner .ph {
2011
- transform: translateY(0.05em); /* Very slight additional adjustment */
2021
+ /* Remove the transform as we're now using consistent vertical-align: middle */
2012
2022
  }
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T11:58:38.017Z",
67
- "dateModified": "2025-07-23T11:58:38.017Z",
66
+ "datePublished": "2025-07-24T08:19:52.206Z",
67
+ "dateModified": "2025-07-24T08:19:52.206Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/documentation-index.html"
@@ -97,7 +97,7 @@
97
97
 
98
98
  <div class="header-actions">
99
99
  <div class="deployment-info">
100
- <span class="deployment-date" title="Built with doc-builder v1.6.4">Last updated: Jul 23, 2025, 11:58 AM UTC</span>
100
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
101
101
  </div>
102
102
 
103
103
 
@@ -148,7 +148,6 @@
148
148
  <div class="nav-content" >
149
149
  <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
150
150
  <a href="/documentation-index.html" class="nav-item active" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
151
- <a href="/test-emojis.html" class="nav-item" data-tooltip="🆘 SOS/Emergency - Should convert to first-aid icon 🚨 Alert - Already working (siren icon) Money and Finance."><i class="fas fa-file-alt"></i> Test Emojis</a>
152
151
  <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
153
152
  <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
154
153
  <div class="nav-section" data-level="1">
@@ -303,7 +302,7 @@
303
302
 
304
303
  **Generated**: YYYY-MM-DD HH:MM UTC
305
304
  **Status**: Draft/Complete
306
- **Verified**: <i class="ph ph-check-circle" aria-label="checked"></i>/<i class="ph ph-question" aria-label="question"></i>
305
+ **Verified**: ✅/❓
307
306
 
308
307
  ## Overview
309
308
 
@@ -363,6 +362,15 @@ Detailed information...
363
362
  </div>
364
363
 
365
364
  <!-- Scripts -->
365
+ <script>
366
+ // Pass configuration to frontend
367
+ window.docBuilderConfig = {
368
+ features: {
369
+ showPdfDownload: true,
370
+ menuDefaultOpen: true
371
+ }
372
+ };
373
+ </script>
366
374
  <script src="/js/main.js"></script>
367
375
 
368
376
  </body>
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T11:58:38.023Z",
67
- "dateModified": "2025-07-23T11:58:38.023Z",
66
+ "datePublished": "2025-07-24T08:19:52.210Z",
67
+ "dateModified": "2025-07-24T08:19:52.210Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/guides/authentication-guide.html"
@@ -103,7 +103,7 @@
103
103
 
104
104
  <div class="header-actions">
105
105
  <div class="deployment-info">
106
- <span class="deployment-date" title="Built with doc-builder v1.6.4">Last updated: Jul 23, 2025, 11:58 AM UTC</span>
106
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
107
107
  </div>
108
108
 
109
109
 
@@ -154,7 +154,6 @@
154
154
  <div class="nav-content" >
155
155
  <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
156
156
  <a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
157
- <a href="/test-emojis.html" class="nav-item" data-tooltip="🆘 SOS/Emergency - Should convert to first-aid icon 🚨 Alert - Already working (siren icon) Money and Finance."><i class="fas fa-file-alt"></i> Test Emojis</a>
158
157
  <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
159
158
  <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
160
159
  <div class="nav-section" data-level="1">
@@ -460,6 +459,15 @@ Please bookmark the site after logging in.
460
459
  </div>
461
460
 
462
461
  <!-- Scripts -->
462
+ <script>
463
+ // Pass configuration to frontend
464
+ window.docBuilderConfig = {
465
+ features: {
466
+ showPdfDownload: true,
467
+ menuDefaultOpen: true
468
+ }
469
+ };
470
+ </script>
463
471
  <script src="/js/main.js"></script>
464
472
 
465
473
  </body>
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T11:58:38.044Z",
67
- "dateModified": "2025-07-23T11:58:38.044Z",
66
+ "datePublished": "2025-07-24T08:19:52.215Z",
67
+ "dateModified": "2025-07-24T08:19:52.215Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/guides/claude-workflow-guide.html"
@@ -103,7 +103,7 @@
103
103
 
104
104
  <div class="header-actions">
105
105
  <div class="deployment-info">
106
- <span class="deployment-date" title="Built with doc-builder v1.6.4">Last updated: Jul 23, 2025, 11:58 AM UTC</span>
106
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
107
107
  </div>
108
108
 
109
109
 
@@ -154,7 +154,6 @@
154
154
  <div class="nav-content" >
155
155
  <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
156
156
  <a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
157
- <a href="/test-emojis.html" class="nav-item" data-tooltip="🆘 SOS/Emergency - Should convert to first-aid icon 🚨 Alert - Already working (siren icon) Money and Finance."><i class="fas fa-file-alt"></i> Test Emojis</a>
158
157
  <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
159
158
  <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
160
159
  <div class="nav-section" data-level="1">
@@ -231,7 +230,7 @@ This file provides comprehensive guidance for Claude Code when working in this p
231
230
  - Include metadata:
232
231
  - **Generated**: YYYY-MM-DD HH:MM UTC
233
232
  - **Status**: Draft/In Progress/Complete
234
- - **Verified**: <i class="ph ph-check-circle" aria-label="checked"></i> (for verified information) / <i class="ph ph-question" aria-label="question"></i> (for speculated information)
233
+ - **Verified**: (for verified information) / (for speculated information)
235
234
 
236
235
  ### Document Structure
237
236
  - All documentation goes in the `/docs` directory
@@ -266,12 +265,12 @@ This file provides comprehensive guidance for Claude Code when working in this p
266
265
  </div>
267
266
 
268
267
  #### 2. Information Verification
269
- - Mark all information as either verified (<i class="ph ph-check-circle" aria-label="checked"></i>) or speculated (<i class="ph ph-question" aria-label="question"></i>)
268
+ - Mark all information as either verified () or speculated ()
270
269
  - Include sources for verified information
271
270
  - Clearly indicate assumptions
272
271
  - Example:
273
- - <i class="ph ph-check-circle" aria-label="checked"></i> This API endpoint requires authentication (verified in auth.js:45)
274
- - <i class="ph ph-question" aria-label="question"></i> Response time should be under 200ms (performance requirement assumed)
272
+ - This API endpoint requires authentication (verified in auth.js:45)
273
+ - Response time should be under 200ms (performance requirement assumed)
275
274
 
276
275
  #### 3. Code Examples
277
276
  - Use proper syntax highlighting with language identifiers
@@ -280,7 +279,7 @@ This file provides comprehensive guidance for Claude Code when working in this p
280
279
  - Add error handling in examples
281
280
  - Example:
282
281
  ```javascript
283
- // <i class="ph ph-check-circle" aria-label="checked"></i> Correct way to call the API
282
+ // Correct way to call the API
284
283
  try {
285
284
  const response = await api.getData({ userId: 123 });
286
285
  console.log(&#39;Data:&#39;, response.data);
@@ -288,7 +287,7 @@ try {
288
287
  console.error(&#39;API Error:&#39;, error.message);
289
288
  }
290
289
 
291
- // <i class="ph ph-x-circle" aria-label="error"></i> Incorrect - missing error handling
290
+ // Incorrect - missing error handling
292
291
  const response = await api.getData({ userId: 123 });
293
292
  </code></pre>
294
293
  <h4>4. Practical Examples</h4>
@@ -523,7 +522,7 @@ For Claude to generate accurate and consistent content, include key organization
523
522
  ### Branding Guidelines
524
523
  - **Company Tagline**: &quot;Beautiful documentation with the least effort possible&quot;
525
524
  - **Primary Color**: #0070f3 (Vercel blue)
526
- - **Logo**: <i class="ph ph-sparkle" aria-label="special"></i> (sparkle emoji)
525
+ - **Logo**: (sparkle emoji)
527
526
  - **Font Family**: Inter, system-ui
528
527
  </code></pre>
529
528
  <p>When these facts are included in your CLAUDE.md, Claude will:</p>
@@ -551,8 +550,8 @@ For Claude to generate accurate and consistent content, include key organization
551
550
 
552
551
  ### Information Verification
553
552
  - Mark all verified vs. speculated information as a general document standard
554
- - Use <i class="ph ph-check-circle" aria-label="checked"></i> for verified information with source references
555
- - Use <i class="ph ph-question" aria-label="question"></i> for assumptions or unverified information
553
+ - Use for verified information with source references
554
+ - Use for assumptions or unverified information
556
555
 
557
556
  ### Development Practices
558
557
  - Use Docker V2 for containerization
@@ -651,15 +650,15 @@ For Claude to generate accurate and consistent content, include key organization
651
650
  </div>
652
651
  <h4>Example: Without Environment Facts</h4>
653
652
  <pre><code class="language-javascript">// Claude might generate:
654
- const API_URL = &#39;https://api.example.com&#39;; // <i class="ph ph-question" aria-label="question"></i> Generic placeholder
655
- const author = &#39;Your Name&#39;; // <i class="ph ph-question" aria-label="question"></i> Placeholder
656
- const email = &#39;email@example.com&#39;; // <i class="ph ph-question" aria-label="question"></i> Generic example
653
+ const API_URL = &#39;https://api.example.com&#39;; // Generic placeholder
654
+ const author = &#39;Your Name&#39;; // Placeholder
655
+ const email = &#39;email@example.com&#39;; // Generic example
657
656
  </code></pre>
658
657
  <h4>Example: With Environment Facts</h4>
659
658
  <pre><code class="language-javascript">// Claude will generate:
660
- const API_URL = &#39;https://api.knowcode.tech&#39;; // <i class="ph ph-check-circle" aria-label="checked"></i> Actual API URL
661
- const author = &#39;Lindsay Smith&#39;; // <i class="ph ph-check-circle" aria-label="checked"></i> Correct author
662
- const email = &#39;support@knowcode.tech&#39;; // <i class="ph ph-check-circle" aria-label="checked"></i> Real contact email
659
+ const API_URL = &#39;https://api.knowcode.tech&#39;; // Actual API URL
660
+ const author = &#39;Lindsay Smith&#39;; // Correct author
661
+ const email = &#39;support@knowcode.tech&#39;; // Real contact email
663
662
  </code></pre>
664
663
  <h2>Step 2: Initialize doc-builder</h2>
665
664
  <pre><code class="language-bash"># Install doc-builder
@@ -907,43 +906,43 @@ npm run deploy:docs
907
906
  ## Best Practices Summary
908
907
 
909
908
  ### Documentation Creation
910
- 1. <i class="ph ph-check-circle" aria-label="checked"></i> Use CLAUDE.md to maintain consistency across all documentation
911
- 2. <i class="ph ph-check-circle" aria-label="checked"></i> Include visual diagrams (Mermaid) for complex concepts and workflows
912
- 3. <i class="ph ph-check-circle" aria-label="checked"></i> Provide practical, working examples that can be copy-pasted
913
- 4. <i class="ph ph-check-circle" aria-label="checked"></i> Mark verification status (<i class="ph ph-check-circle" aria-label="checked"></i>/<i class="ph ph-question" aria-label="question"></i>) for all technical information
914
- 5. <i class="ph ph-check-circle" aria-label="checked"></i> Keep documentation close to code in the /docs directory
915
- 6. <i class="ph ph-check-circle" aria-label="checked"></i> Include metadata headers with timestamps and status
916
- 7. <i class="ph ph-check-circle" aria-label="checked"></i> Add troubleshooting sections for common issues
917
- 8. <i class="ph ph-check-circle" aria-label="checked"></i> Cross-reference related documentation
909
+ 1. Use CLAUDE.md to maintain consistency across all documentation
910
+ 2. Include visual diagrams (Mermaid) for complex concepts and workflows
911
+ 3. Provide practical, working examples that can be copy-pasted
912
+ 4. Mark verification status (✅/❓) for all technical information
913
+ 5. Keep documentation close to code in the /docs directory
914
+ 6. Include metadata headers with timestamps and status
915
+ 7. Add troubleshooting sections for common issues
916
+ 8. Cross-reference related documentation
918
917
 
919
918
  ### Claude Interaction
920
- 1. <i class="ph ph-check-circle" aria-label="checked"></i> Provide clear, specific requests with expected output format
921
- 2. <i class="ph ph-check-circle" aria-label="checked"></i> Reference existing patterns from CLAUDE.md
922
- 3. <i class="ph ph-check-circle" aria-label="checked"></i> Request iterative improvements - review and refine
923
- 4. <i class="ph ph-check-circle" aria-label="checked"></i> Verify technical accuracy of generated content
924
- 5. <i class="ph ph-check-circle" aria-label="checked"></i> Ask for troubleshooting sections explicitly
925
- 6. <i class="ph ph-check-circle" aria-label="checked"></i> Request examples with error handling
926
- 7. <i class="ph ph-check-circle" aria-label="checked"></i> Specify diagram types needed (sequence, flow, state)
927
- 8. <i class="ph ph-check-circle" aria-label="checked"></i> Ask Claude to check its own work against CLAUDE.md standards
919
+ 1. Provide clear, specific requests with expected output format
920
+ 2. Reference existing patterns from CLAUDE.md
921
+ 3. Request iterative improvements - review and refine
922
+ 4. Verify technical accuracy of generated content
923
+ 5. Ask for troubleshooting sections explicitly
924
+ 6. Request examples with error handling
925
+ 7. Specify diagram types needed (sequence, flow, state)
926
+ 8. Ask Claude to check its own work against CLAUDE.md standards
928
927
 
929
928
  ### Documentation Maintenance
930
- 1. <i class="ph ph-check-circle" aria-label="checked"></i> Update docs when code changes
931
- 2. <i class="ph ph-check-circle" aria-label="checked"></i> Archive outdated documentation
932
- 3. <i class="ph ph-check-circle" aria-label="checked"></i> Maintain CHANGELOG.md
933
- 4. <i class="ph ph-check-circle" aria-label="checked"></i> Review documentation quarterly
934
- 5. <i class="ph ph-check-circle" aria-label="checked"></i> Test all code examples
935
- 6. <i class="ph ph-check-circle" aria-label="checked"></i> Check for broken links
936
- 7. <i class="ph ph-check-circle" aria-label="checked"></i> Update version references
929
+ 1. Update docs when code changes
930
+ 2. Archive outdated documentation
931
+ 3. Maintain CHANGELOG.md
932
+ 4. Review documentation quarterly
933
+ 5. Test all code examples
934
+ 6. Check for broken links
935
+ 7. Update version references
937
936
 
938
937
  ### Deployment
939
- 1. <i class="ph ph-check-circle" aria-label="checked"></i> Test locally before deploying (npm run dev:docs)
940
- 2. <i class="ph ph-check-circle" aria-label="checked"></i> Build and verify output (npm run build:docs)
941
- 3. <i class="ph ph-check-circle" aria-label="checked"></i> Use preview deployments first
942
- 4. <i class="ph ph-check-circle" aria-label="checked"></i> Configure custom domains if needed
943
- 5. <i class="ph ph-check-circle" aria-label="checked"></i> Enable HTTPS (automatic with Vercel)
944
- 6. <i class="ph ph-check-circle" aria-label="checked"></i> Monitor deployment health
945
- 7. <i class="ph ph-check-circle" aria-label="checked"></i> Disable Vercel authentication for public docs
946
- 8. <i class="ph ph-check-circle" aria-label="checked"></i> Commit documentation changes before deploying
938
+ 1. Test locally before deploying (npm run dev:docs)
939
+ 2. Build and verify output (npm run build:docs)
940
+ 3. Use preview deployments first
941
+ 4. Configure custom domains if needed
942
+ 5. Enable HTTPS (automatic with Vercel)
943
+ 6. Monitor deployment health
944
+ 7. Disable Vercel authentication for public docs
945
+ 8. Commit documentation changes before deploying
947
946
 
948
947
  ## Common Issues and Solutions
949
948
 
@@ -982,6 +981,15 @@ The key to success is iterative refinement of your CLAUDE.md file to capture you
982
981
  </div>
983
982
 
984
983
  <!-- Scripts -->
984
+ <script>
985
+ // Pass configuration to frontend
986
+ window.docBuilderConfig = {
987
+ features: {
988
+ showPdfDownload: true,
989
+ menuDefaultOpen: true
990
+ }
991
+ };
992
+ </script>
985
993
  <script src="/js/main.js"></script>
986
994
 
987
995
  </body>