@knowcode/doc-builder 1.6.1 → 1.6.3
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.
- package/html/README.html +4 -4
- package/html/documentation-index.html +3 -3
- package/html/guides/authentication-guide.html +3 -3
- package/html/guides/claude-workflow-guide.html +119 -6
- package/html/guides/documentation-standards.html +3 -3
- package/html/guides/phosphor-icons-guide.html +3 -3
- package/html/guides/search-engine-verification-guide.html +3 -3
- package/html/guides/seo-guide.html +3 -3
- package/html/guides/seo-optimization-guide.html +3 -3
- package/html/guides/troubleshooting-guide.html +3 -3
- package/html/guides/windows-setup-guide.html +6 -6
- package/html/index.html +4 -4
- package/html/launch/README.html +3 -3
- package/html/launch/bubble-plugin-specification.html +3 -3
- package/html/launch/go-to-market-strategy.html +3 -3
- package/html/launch/launch-announcements.html +4 -4
- package/html/sitemap.xml +21 -21
- package/html/vercel-cli-setup-guide.html +3 -3
- package/html/vercel-first-time-setup-guide.html +3 -3
- package/lib/config.js +2 -1
- package/lib/core-builder.js +48 -5
- package/lib/emoji-mapper.js +1 -0
- package/package.json +1 -1
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-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.374Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.374Z",
|
|
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.
|
|
100
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
101
101
|
</div>
|
|
102
102
|
|
|
103
103
|
|
|
@@ -401,7 +401,7 @@ docBuilder.build({
|
|
|
401
401
|
<p><strong>Connect with us:</strong></p>
|
|
402
402
|
<ul>
|
|
403
403
|
<li><i class="ph ph-package" aria-label="package"></i> <a href="https://www.npmjs.com/package/@knowcode/doc-builder">NPM Package</a></li>
|
|
404
|
-
<li
|
|
404
|
+
<li><i class="ph ph-github-logo" aria-label="github"></i> <a href="https://github.com/wapdat/doc-builder">GitHub Repo</a></li>
|
|
405
405
|
<li><i class="ph ph-globe" aria-label="global"></i> <a href="https://knowcode.com">Website</a></li>
|
|
406
406
|
<li><i class="ph ph-chat-circle" aria-label="chat"></i> <a href="https://github.com/wapdat/doc-builder/discussions">Discussions</a></li>
|
|
407
407
|
</ul>
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.384Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.384Z",
|
|
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.
|
|
100
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
101
101
|
</div>
|
|
102
102
|
|
|
103
103
|
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.387Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.387Z",
|
|
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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.391Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.391Z",
|
|
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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -462,12 +462,81 @@ function handleError(error) {
|
|
|
462
462
|
<li><a href="/CONTRIBUTING.md">Contributing Guide</a></li>
|
|
463
463
|
</ul>
|
|
464
464
|
<pre><code>
|
|
465
|
-
### 1.2
|
|
465
|
+
### 1.2 Setting Up Admin/Background/Environment Facts
|
|
466
466
|
|
|
467
|
-
|
|
467
|
+
For Claude to generate accurate and consistent content, include key organizational and environmental facts in your CLAUDE.md. This ensures all generated documentation uses correct information:
|
|
468
468
|
|
|
469
469
|
```markdown
|
|
470
|
-
|
|
470
|
+
## Organization & Environment Facts
|
|
471
|
+
|
|
472
|
+
### Company Information
|
|
473
|
+
- **Organization Name**: Knowcode Ltd
|
|
474
|
+
- **Website**: https://knowcode.tech
|
|
475
|
+
- **Contact Email**: support@knowcode.tech
|
|
476
|
+
- **GitHub Organization**: https://github.com/knowcode
|
|
477
|
+
- **NPM Organization**: @knowcode
|
|
478
|
+
|
|
479
|
+
### Author Information
|
|
480
|
+
- **Primary Author**: Lindsay Smith
|
|
481
|
+
- **Author Email**: lindsay@knowcode.tech
|
|
482
|
+
- **Author Title**: Lead Developer
|
|
483
|
+
- **GitHub Handle**: @lindsaysmith
|
|
484
|
+
- **Twitter/X Handle**: @planbbackups
|
|
485
|
+
|
|
486
|
+
### Project Environment
|
|
487
|
+
- **Production URL**: https://doc-builder-delta.vercel.app
|
|
488
|
+
- **Staging URL**: https://doc-builder-staging.vercel.app
|
|
489
|
+
- **Documentation URL**: https://docs.knowcode.tech
|
|
490
|
+
- **API Base URL**: https://api.knowcode.tech
|
|
491
|
+
- **CDN URL**: https://cdn.knowcode.tech
|
|
492
|
+
|
|
493
|
+
### Default Settings
|
|
494
|
+
- **Default Language**: en-US
|
|
495
|
+
- **Timezone**: UTC
|
|
496
|
+
- **Date Format**: YYYY-MM-DD
|
|
497
|
+
- **Copyright Year**: 2025
|
|
498
|
+
- **License**: MIT
|
|
499
|
+
- **Version**: 1.6.2
|
|
500
|
+
|
|
501
|
+
### SEO Defaults
|
|
502
|
+
- **Default Author**: Lindsay Smith
|
|
503
|
+
- **Organization Type**: Software Company
|
|
504
|
+
- **Twitter Handle**: @planbbackups
|
|
505
|
+
- **LinkedIn**: https://linkedin.com/company/knowcode
|
|
506
|
+
- **Facebook Page**: https://facebook.com/knowcode
|
|
507
|
+
|
|
508
|
+
### Technical Stack
|
|
509
|
+
- **Primary Language**: JavaScript/TypeScript
|
|
510
|
+
- **Node Version**: 20.x LTS
|
|
511
|
+
- **Package Manager**: npm (not yarn or pnpm)
|
|
512
|
+
- **Cloud Provider**: AWS (primary), Vercel (hosting)
|
|
513
|
+
- **Region**: eu-west-1
|
|
514
|
+
- **Container Registry**: Docker Hub
|
|
515
|
+
|
|
516
|
+
### Communication Standards
|
|
517
|
+
- **Support Response Time**: 24-48 hours
|
|
518
|
+
- **Documentation Language**: US English
|
|
519
|
+
- **Tone**: Professional but friendly
|
|
520
|
+
- **Technical Level**: Intermediate developers
|
|
521
|
+
|
|
522
|
+
### Branding Guidelines
|
|
523
|
+
- **Company Tagline**: "Beautiful documentation with the least effort possible"
|
|
524
|
+
- **Primary Color**: #0070f3 (Vercel blue)
|
|
525
|
+
- **Logo**: <i class="ph ph-sparkle" aria-label="special"></i> (sparkle emoji)
|
|
526
|
+
- **Font Family**: Inter, system-ui
|
|
527
|
+
</code></pre>
|
|
528
|
+
<p>When these facts are included in your CLAUDE.md, Claude will:</p>
|
|
529
|
+
<ul>
|
|
530
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Use correct contact information in examples</li>
|
|
531
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Reference the right URLs in documentation</li>
|
|
532
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Apply consistent author attribution</li>
|
|
533
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Generate accurate meta tags for SEO</li>
|
|
534
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Use proper organizational context</li>
|
|
535
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Follow established technical standards</li>
|
|
536
|
+
</ul>
|
|
537
|
+
<h3>1.3 Global CLAUDE.md Best Practices</h3>
|
|
538
|
+
<p>Your global <code>~/.claude/CLAUDE.md</code> should include universal standards that apply to all projects. Here's an expanded example:</p>
|
|
539
|
+
<pre><code class="language-markdown"># Global CLAUDE.md Instructions
|
|
471
540
|
|
|
472
541
|
## Universal Documentation Standards
|
|
473
542
|
|
|
@@ -548,6 +617,49 @@ Your global `~/.claude/CLAUDE.md` should include universal standards that apply
|
|
|
548
617
|
F --> F2[Build Optimization]
|
|
549
618
|
F --> F3[Caching Strategies]</div>
|
|
550
619
|
</div>
|
|
620
|
+
<h3>1.4 Benefits of Environment Facts in Documentation</h3>
|
|
621
|
+
<p>Including these environmental facts in your CLAUDE.md provides several key benefits:</p>
|
|
622
|
+
<div class="mermaid-wrapper">
|
|
623
|
+
<div class="mermaid">graph TD
|
|
624
|
+
A[Environment Facts in CLAUDE.md] --> B[Accurate Content]
|
|
625
|
+
A --> C[Consistent Branding]
|
|
626
|
+
A --> D[Proper Attribution]
|
|
627
|
+
A --> E[SEO Optimization]
|
|
628
|
+
|
|
629
|
+
B --> B1[Correct URLs in examples]
|
|
630
|
+
B --> B2[Valid email addresses]
|
|
631
|
+
B --> B3[Accurate version numbers]
|
|
632
|
+
|
|
633
|
+
C --> C1[Company name consistency]
|
|
634
|
+
C --> C2[Tagline usage]
|
|
635
|
+
C --> C3[Brand colors]
|
|
636
|
+
|
|
637
|
+
D --> D1[Author metadata]
|
|
638
|
+
D --> D2[Copyright notices]
|
|
639
|
+
D --> D3[License references]
|
|
640
|
+
|
|
641
|
+
E --> E1[Meta tag generation]
|
|
642
|
+
E --> E2[Social media tags]
|
|
643
|
+
E --> E3[Structured data]
|
|
644
|
+
|
|
645
|
+
style A fill:#e3f2fd
|
|
646
|
+
style B fill:#c8e6c9
|
|
647
|
+
style C fill:#fff9c4
|
|
648
|
+
style D fill:#ffccbc
|
|
649
|
+
style E fill:#d1c4e9</div>
|
|
650
|
+
</div>
|
|
651
|
+
<h4>Example: Without Environment Facts</h4>
|
|
652
|
+
<pre><code class="language-javascript">// Claude might generate:
|
|
653
|
+
const API_URL = 'https://api.example.com'; // <i class="ph ph-question" aria-label="question"></i> Generic placeholder
|
|
654
|
+
const author = 'Your Name'; // <i class="ph ph-question" aria-label="question"></i> Placeholder
|
|
655
|
+
const email = 'email@example.com'; // <i class="ph ph-question" aria-label="question"></i> Generic example
|
|
656
|
+
</code></pre>
|
|
657
|
+
<h4>Example: With Environment Facts</h4>
|
|
658
|
+
<pre><code class="language-javascript">// Claude will generate:
|
|
659
|
+
const API_URL = 'https://api.knowcode.tech'; // <i class="ph ph-check-circle" aria-label="checked"></i> Actual API URL
|
|
660
|
+
const author = 'Lindsay Smith'; // <i class="ph ph-check-circle" aria-label="checked"></i> Correct author
|
|
661
|
+
const email = 'support@knowcode.tech'; // <i class="ph ph-check-circle" aria-label="checked"></i> Real contact email
|
|
662
|
+
</code></pre>
|
|
551
663
|
<h2>Step 2: Initialize doc-builder</h2>
|
|
552
664
|
<pre><code class="language-bash"># Install doc-builder
|
|
553
665
|
npm install -D @knowcode/doc-builder
|
|
@@ -861,6 +973,7 @@ The key to success is iterative refinement of your CLAUDE.md file to capture you
|
|
|
861
973
|
| Date | Author | Changes |
|
|
862
974
|
|------|--------|---------|
|
|
863
975
|
| 2025-07-21 | Claude | Initial creation |
|
|
976
|
+
| 2025-07-23 | Lindsay Smith | Added section on environment facts for accurate content generation |
|
|
864
977
|
</code></pre>
|
|
865
978
|
|
|
866
979
|
</div>
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.394Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.394Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/guides/documentation-standards.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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.397Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.397Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/guides/phosphor-icons-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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.403Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.403Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/guides/search-engine-verification-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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.407Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.407Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/guides/seo-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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.413Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.413Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/guides/seo-optimization-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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.416Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.416Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/guides/troubleshooting-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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
6
|
<meta name="description" content="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel. Based on real...">
|
|
7
|
-
<title>Windows Setup Guide for Claude Code & @knowcode
|
|
7
|
+
<title>Windows Setup Guide for Claude Code & @knowcode...</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
10
10
|
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, claude, code">
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
<!-- Open Graph / Facebook -->
|
|
15
15
|
<meta property="og:type" content="article">
|
|
16
16
|
<meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/windows-setup-guide.html">
|
|
17
|
-
<meta property="og:title" content="Windows Setup Guide for Claude Code & @knowcode
|
|
17
|
+
<meta property="og:title" content="Windows Setup Guide for Claude Code & @knowcode...">
|
|
18
18
|
<meta property="og:description" content="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel. Based on real...">
|
|
19
19
|
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
20
|
<meta property="og:site_name" content="@knowcode/doc-builder">
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
<meta name="twitter:card" content="summary_large_image">
|
|
25
25
|
<meta name="twitter:site" content="@planbbackups">
|
|
26
26
|
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
-
<meta name="twitter:title" content="Windows Setup Guide for Claude Code & @knowcode
|
|
27
|
+
<meta name="twitter:title" content="Windows Setup Guide for Claude Code & @knowcode...">
|
|
28
28
|
<meta name="twitter:description" content="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel. Based on real...">
|
|
29
29
|
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
30
|
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.421Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.421Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/guides/windows-setup-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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
package/html/index.html
CHANGED
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.374Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.374Z",
|
|
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.
|
|
100
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
101
101
|
</div>
|
|
102
102
|
|
|
103
103
|
|
|
@@ -401,7 +401,7 @@ docBuilder.build({
|
|
|
401
401
|
<p><strong>Connect with us:</strong></p>
|
|
402
402
|
<ul>
|
|
403
403
|
<li><i class="ph ph-package" aria-label="package"></i> <a href="https://www.npmjs.com/package/@knowcode/doc-builder">NPM Package</a></li>
|
|
404
|
-
<li
|
|
404
|
+
<li><i class="ph ph-github-logo" aria-label="github"></i> <a href="https://github.com/wapdat/doc-builder">GitHub Repo</a></li>
|
|
405
405
|
<li><i class="ph ph-globe" aria-label="global"></i> <a href="https://knowcode.com">Website</a></li>
|
|
406
406
|
<li><i class="ph ph-chat-circle" aria-label="chat"></i> <a href="https://github.com/wapdat/doc-builder/discussions">Discussions</a></li>
|
|
407
407
|
</ul>
|
package/html/launch/README.html
CHANGED
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.423Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.423Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/launch/README.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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.427Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.427Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/launch/bubble-plugin-specification.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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.431Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.431Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/launch/go-to-market-strategy.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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.435Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.435Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/launch/launch-announcements.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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -416,7 +416,7 @@ npx @knowcode/doc-builder@latest deploy
|
|
|
416
416
|
<ul>
|
|
417
417
|
<li><i class="ph ph-rocket-launch" aria-label="launch"></i> <a href="https://doc-builder-delta.vercel.app">Live Demo</a></li>
|
|
418
418
|
<li><i class="ph ph-package" aria-label="package"></i> <a href="https://www.npmjs.com/package/@knowcode/doc-builder">NPM Package</a></li>
|
|
419
|
-
<li
|
|
419
|
+
<li><i class="ph ph-github-logo" aria-label="github"></i> <a href="https://github.com/knowcode/doc-builder">GitHub Repo</a> (coming soon)</li>
|
|
420
420
|
</ul>
|
|
421
421
|
<p>What's your biggest documentation pain point? Let me know in the comments!</p>
|
|
422
422
|
<h2>Reddit Posts</h2>
|
package/html/sitemap.xml
CHANGED
|
@@ -2,127 +2,127 @@
|
|
|
2
2
|
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
|
3
3
|
<url>
|
|
4
4
|
<loc>https://doc-builder-delta.vercel.app/404.html</loc>
|
|
5
|
-
<lastmod>2025-07-
|
|
5
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
6
6
|
<changefreq>monthly</changefreq>
|
|
7
7
|
<priority>0.6</priority>
|
|
8
8
|
</url>
|
|
9
9
|
<url>
|
|
10
10
|
<loc>https://doc-builder-delta.vercel.app/README.html</loc>
|
|
11
|
-
<lastmod>2025-07-
|
|
11
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
12
12
|
<changefreq>monthly</changefreq>
|
|
13
13
|
<priority>0.6</priority>
|
|
14
14
|
</url>
|
|
15
15
|
<url>
|
|
16
16
|
<loc>https://doc-builder-delta.vercel.app/claude-workflow-guide.html</loc>
|
|
17
|
-
<lastmod>2025-07-
|
|
17
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
18
18
|
<changefreq>monthly</changefreq>
|
|
19
19
|
<priority>0.8</priority>
|
|
20
20
|
</url>
|
|
21
21
|
<url>
|
|
22
22
|
<loc>https://doc-builder-delta.vercel.app/documentation-index.html</loc>
|
|
23
|
-
<lastmod>2025-07-
|
|
23
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
24
24
|
<changefreq>monthly</changefreq>
|
|
25
25
|
<priority>0.6</priority>
|
|
26
26
|
</url>
|
|
27
27
|
<url>
|
|
28
28
|
<loc>https://doc-builder-delta.vercel.app/guides/authentication-guide.html</loc>
|
|
29
|
-
<lastmod>2025-07-
|
|
29
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
30
30
|
<changefreq>monthly</changefreq>
|
|
31
31
|
<priority>0.8</priority>
|
|
32
32
|
</url>
|
|
33
33
|
<url>
|
|
34
34
|
<loc>https://doc-builder-delta.vercel.app/guides/claude-workflow-guide.html</loc>
|
|
35
|
-
<lastmod>2025-07-
|
|
35
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
36
36
|
<changefreq>monthly</changefreq>
|
|
37
37
|
<priority>0.8</priority>
|
|
38
38
|
</url>
|
|
39
39
|
<url>
|
|
40
40
|
<loc>https://doc-builder-delta.vercel.app/guides/document-standards.html</loc>
|
|
41
|
-
<lastmod>2025-07-
|
|
41
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
42
42
|
<changefreq>monthly</changefreq>
|
|
43
43
|
<priority>0.8</priority>
|
|
44
44
|
</url>
|
|
45
45
|
<url>
|
|
46
46
|
<loc>https://doc-builder-delta.vercel.app/guides/documentation-standards.html</loc>
|
|
47
|
-
<lastmod>2025-07-
|
|
47
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
48
48
|
<changefreq>monthly</changefreq>
|
|
49
49
|
<priority>0.8</priority>
|
|
50
50
|
</url>
|
|
51
51
|
<url>
|
|
52
52
|
<loc>https://doc-builder-delta.vercel.app/guides/phosphor-icons-guide.html</loc>
|
|
53
|
-
<lastmod>2025-07-
|
|
53
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
54
54
|
<changefreq>monthly</changefreq>
|
|
55
55
|
<priority>0.8</priority>
|
|
56
56
|
</url>
|
|
57
57
|
<url>
|
|
58
58
|
<loc>https://doc-builder-delta.vercel.app/guides/search-engine-verification-guide.html</loc>
|
|
59
|
-
<lastmod>2025-07-
|
|
59
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
60
60
|
<changefreq>monthly</changefreq>
|
|
61
61
|
<priority>0.8</priority>
|
|
62
62
|
</url>
|
|
63
63
|
<url>
|
|
64
64
|
<loc>https://doc-builder-delta.vercel.app/guides/seo-guide.html</loc>
|
|
65
|
-
<lastmod>2025-07-
|
|
65
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
66
66
|
<changefreq>monthly</changefreq>
|
|
67
67
|
<priority>0.8</priority>
|
|
68
68
|
</url>
|
|
69
69
|
<url>
|
|
70
70
|
<loc>https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html</loc>
|
|
71
|
-
<lastmod>2025-07-
|
|
71
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
72
72
|
<changefreq>monthly</changefreq>
|
|
73
73
|
<priority>0.8</priority>
|
|
74
74
|
</url>
|
|
75
75
|
<url>
|
|
76
76
|
<loc>https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html</loc>
|
|
77
|
-
<lastmod>2025-07-
|
|
77
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
78
78
|
<changefreq>monthly</changefreq>
|
|
79
79
|
<priority>0.8</priority>
|
|
80
80
|
</url>
|
|
81
81
|
<url>
|
|
82
82
|
<loc>https://doc-builder-delta.vercel.app/guides/windows-setup-guide.html</loc>
|
|
83
|
-
<lastmod>2025-07-
|
|
83
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
84
84
|
<changefreq>monthly</changefreq>
|
|
85
85
|
<priority>0.8</priority>
|
|
86
86
|
</url>
|
|
87
87
|
<url>
|
|
88
88
|
<loc>https://doc-builder-delta.vercel.app/index.html</loc>
|
|
89
|
-
<lastmod>2025-07-
|
|
89
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
90
90
|
<changefreq>weekly</changefreq>
|
|
91
91
|
<priority>1.0</priority>
|
|
92
92
|
</url>
|
|
93
93
|
<url>
|
|
94
94
|
<loc>https://doc-builder-delta.vercel.app/launch/README.html</loc>
|
|
95
|
-
<lastmod>2025-07-
|
|
95
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
96
96
|
<changefreq>monthly</changefreq>
|
|
97
97
|
<priority>0.6</priority>
|
|
98
98
|
</url>
|
|
99
99
|
<url>
|
|
100
100
|
<loc>https://doc-builder-delta.vercel.app/launch/bubble-plugin-specification.html</loc>
|
|
101
|
-
<lastmod>2025-07-
|
|
101
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
102
102
|
<changefreq>monthly</changefreq>
|
|
103
103
|
<priority>0.6</priority>
|
|
104
104
|
</url>
|
|
105
105
|
<url>
|
|
106
106
|
<loc>https://doc-builder-delta.vercel.app/launch/go-to-market-strategy.html</loc>
|
|
107
|
-
<lastmod>2025-07-
|
|
107
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
108
108
|
<changefreq>monthly</changefreq>
|
|
109
109
|
<priority>0.6</priority>
|
|
110
110
|
</url>
|
|
111
111
|
<url>
|
|
112
112
|
<loc>https://doc-builder-delta.vercel.app/launch/launch-announcements.html</loc>
|
|
113
|
-
<lastmod>2025-07-
|
|
113
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
114
114
|
<changefreq>monthly</changefreq>
|
|
115
115
|
<priority>0.6</priority>
|
|
116
116
|
</url>
|
|
117
117
|
<url>
|
|
118
118
|
<loc>https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.html</loc>
|
|
119
|
-
<lastmod>2025-07-
|
|
119
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
120
120
|
<changefreq>monthly</changefreq>
|
|
121
121
|
<priority>0.8</priority>
|
|
122
122
|
</url>
|
|
123
123
|
<url>
|
|
124
124
|
<loc>https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html</loc>
|
|
125
|
-
<lastmod>2025-07-
|
|
125
|
+
<lastmod>2025-07-23T09:24:11.449Z</lastmod>
|
|
126
126
|
<changefreq>monthly</changefreq>
|
|
127
127
|
<priority>0.8</priority>
|
|
128
128
|
</url>
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.437Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.437Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.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.
|
|
100
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
101
101
|
</div>
|
|
102
102
|
|
|
103
103
|
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-23T09:24:11.440Z",
|
|
67
|
+
"dateModified": "2025-07-23T09:24:11.440Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.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.
|
|
100
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.2">Last updated: Jul 23, 2025, 09:24 AM UTC</span>
|
|
101
101
|
</div>
|
|
102
102
|
|
|
103
103
|
|
package/lib/config.js
CHANGED
|
@@ -27,7 +27,8 @@ const defaultConfig = {
|
|
|
27
27
|
darkMode: true,
|
|
28
28
|
phosphorIcons: true,
|
|
29
29
|
phosphorWeight: 'regular', // Options: thin, light, regular, bold, fill, duotone
|
|
30
|
-
phosphorSize: '1.2em'
|
|
30
|
+
phosphorSize: '1.2em', // Relative to text size
|
|
31
|
+
normalizeTitle: true // Auto-normalize all-caps titles to title case
|
|
31
32
|
},
|
|
32
33
|
|
|
33
34
|
// Authentication (if enabled)
|
package/lib/core-builder.js
CHANGED
|
@@ -23,6 +23,34 @@ marked.setOptions({
|
|
|
23
23
|
gfm: true
|
|
24
24
|
});
|
|
25
25
|
|
|
26
|
+
// Helper function to normalize titles
|
|
27
|
+
function normalizeTitle(title) {
|
|
28
|
+
if (!title) return title;
|
|
29
|
+
|
|
30
|
+
// Check if title is all caps (more than 50% uppercase letters)
|
|
31
|
+
const upperCount = (title.match(/[A-Z]/g) || []).length;
|
|
32
|
+
const letterCount = (title.match(/[a-zA-Z]/g) || []).length;
|
|
33
|
+
const isAllCaps = letterCount > 0 && (upperCount / letterCount) > 0.5;
|
|
34
|
+
|
|
35
|
+
if (isAllCaps) {
|
|
36
|
+
// Convert to title case
|
|
37
|
+
return title.toLowerCase()
|
|
38
|
+
.split(' ')
|
|
39
|
+
.map(word => {
|
|
40
|
+
// Keep small words lowercase unless they're first
|
|
41
|
+
const smallWords = ['a', 'an', 'and', 'as', 'at', 'but', 'by', 'for', 'from',
|
|
42
|
+
'in', 'into', 'of', 'on', 'or', 'the', 'to', 'with'];
|
|
43
|
+
if (smallWords.includes(word.toLowerCase()) && word !== title.split(' ')[0]) {
|
|
44
|
+
return word.toLowerCase();
|
|
45
|
+
}
|
|
46
|
+
return word.charAt(0).toUpperCase() + word.slice(1);
|
|
47
|
+
})
|
|
48
|
+
.join(' ');
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
return title;
|
|
52
|
+
}
|
|
53
|
+
|
|
26
54
|
// Helper function to escape HTML
|
|
27
55
|
function escapeHtml(text) {
|
|
28
56
|
const map = {
|
|
@@ -245,10 +273,22 @@ function generateHTML(title, content, navigation, currentPath = '', config = {},
|
|
|
245
273
|
.replace('{pageTitle}', title)
|
|
246
274
|
.replace('{siteName}', siteName);
|
|
247
275
|
|
|
248
|
-
// Ensure title is within 50-60 characters
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
276
|
+
// Ensure title is within optimal SEO length (50-60 characters)
|
|
277
|
+
if (seoTitle.length > 60) {
|
|
278
|
+
// Try different approaches to fit within limits
|
|
279
|
+
if (title.length <= 50) {
|
|
280
|
+
// If page title fits, just use that
|
|
281
|
+
finalSeoTitle = title;
|
|
282
|
+
} else if (title.length > 50) {
|
|
283
|
+
// Truncate page title but keep meaningful part
|
|
284
|
+
const truncatedTitle = title.substring(0, 47) + '...';
|
|
285
|
+
finalSeoTitle = truncatedTitle;
|
|
286
|
+
} else {
|
|
287
|
+
finalSeoTitle = seoTitle.substring(0, 57) + '...';
|
|
288
|
+
}
|
|
289
|
+
} else {
|
|
290
|
+
finalSeoTitle = seoTitle;
|
|
291
|
+
}
|
|
252
292
|
|
|
253
293
|
// Generate meta tags
|
|
254
294
|
seoTags = generateMetaTags({
|
|
@@ -622,7 +662,10 @@ async function processMarkdownFile(filePath, outputPath, allFiles, config) {
|
|
|
622
662
|
// Extract title - priority: front matter > H1 > filename
|
|
623
663
|
const h1Match = content.match(/^#\s+(.+)$/m);
|
|
624
664
|
const h1Title = h1Match ? h1Match[1] : null;
|
|
625
|
-
|
|
665
|
+
|
|
666
|
+
// Normalize title if needed (e.g., convert all-caps to title case)
|
|
667
|
+
const rawTitle = frontMatter.title || h1Title || fileName;
|
|
668
|
+
const title = config.features?.normalizeTitle !== false ? normalizeTitle(rawTitle) : rawTitle;
|
|
626
669
|
|
|
627
670
|
// Extract summary for tooltip - priority: front matter > auto-extract
|
|
628
671
|
const summary = frontMatter.description || extractSummary(content);
|
package/lib/emoji-mapper.js
CHANGED
|
@@ -34,6 +34,7 @@ const emojiToPhosphor = {
|
|
|
34
34
|
'🐛': '<i class="ph ph-bug" aria-label="bug"></i>',
|
|
35
35
|
'🐞': '<i class="ph ph-bug-beetle" aria-label="bug"></i>',
|
|
36
36
|
'🤖': '<i class="ph ph-robot" aria-label="automation"></i>',
|
|
37
|
+
'🐙': '<i class="ph ph-github-logo" aria-label="github"></i>',
|
|
37
38
|
|
|
38
39
|
// Documents & Files
|
|
39
40
|
'📝': '<i class="ph ph-note-pencil" aria-label="edit"></i>',
|