@knowcode/doc-builder 1.5.16 → 1.5.18
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/.claude/settings.local.json +2 -1
- package/CHANGELOG.md +26 -0
- package/README.md +69 -11
- package/assets/css/notion-style.css +2 -0
- package/cli.js +22 -22
- package/html/README.html +8 -8
- package/html/css/notion-style.css +2 -0
- package/html/documentation-index.html +5 -4
- package/html/guides/authentication-guide.html +10 -10
- package/html/guides/claude-workflow-guide.html +377 -50
- package/html/guides/documentation-standards.html +5 -5
- package/html/guides/google-site-verification-guide.html +5 -4
- package/html/guides/phosphor-icons-guide.html +5 -4
- package/html/guides/seo-guide.html +9 -8
- package/html/guides/seo-optimization-guide.html +5 -4
- package/html/guides/troubleshooting-guide.html +15 -15
- package/html/guides/windows-setup-guide.html +763 -0
- package/html/index.html +8 -8
- package/html/js/main.js +0 -18
- package/html/sitemap.xml +22 -16
- package/html/vercel-cli-setup-guide.html +7 -6
- package/html/vercel-first-time-setup-guide.html +7 -6
- package/lib/core-builder.js +5 -5
- package/lib/deploy.js +6 -6
- package/package.json +1 -1
- package/recordings/mh-ls-22jul.txt +2305 -0
- package/scripts/setup.js +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,32 @@ All notable changes to @knowcode/doc-builder will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [1.5.18] - 2025-07-22
|
|
9
|
+
|
|
10
|
+
### Documentation
|
|
11
|
+
- Enhanced Claude + CLAUDE.md Documentation Workflow Guide with comprehensive examples
|
|
12
|
+
- Expanded Project-Level CLAUDE.md section with complete template and best practices
|
|
13
|
+
- Added detailed document structure, naming conventions, and content requirements
|
|
14
|
+
- Included information verification standards with ✅/❓ marks
|
|
15
|
+
- Expanded Global CLAUDE.md best practices with real-world examples
|
|
16
|
+
- Enhanced project-specific instructions for API, testing, and deployment docs
|
|
17
|
+
- Updated best practices summary with detailed guidelines for documentation maintenance
|
|
18
|
+
|
|
19
|
+
## [1.5.17] - 2025-07-22
|
|
20
|
+
|
|
21
|
+
### Changed
|
|
22
|
+
- CSS table alignment now defaults to top-aligned instead of center-aligned
|
|
23
|
+
- Updated Windows Setup Guide with improved Vercel project setup section
|
|
24
|
+
- Added detailed explanations for each Vercel setup prompt
|
|
25
|
+
- Added comprehensive Vercel project naming requirements and examples
|
|
26
|
+
- Updated deploy.js with clearer project name hint showing URL format
|
|
27
|
+
|
|
28
|
+
### Documentation
|
|
29
|
+
- Created comprehensive Windows Setup Guide for Claude Code and doc-builder
|
|
30
|
+
- Added explanation of Claude vs Claude Code differences
|
|
31
|
+
- Updated to clarify GitHub is required for Vercel
|
|
32
|
+
- Added details that Pro/Max plan is required for Claude Code
|
|
33
|
+
|
|
8
34
|
## [1.5.16] - 2025-07-22
|
|
9
35
|
|
|
10
36
|
### Changed
|
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@ Beautiful documentation with the least effort possible. A zero-configuration doc
|
|
|
8
8
|
|
|
9
9
|
### Quick Start
|
|
10
10
|
```bash
|
|
11
|
-
npx @knowcode/doc-builder deploy
|
|
11
|
+
npx @knowcode/doc-builder@latest deploy
|
|
12
12
|
```
|
|
13
13
|
|
|
14
14
|
</div>
|
|
@@ -78,6 +78,56 @@ This aligns perfectly with our mission: beautiful documentation should be access
|
|
|
78
78
|
</tr>
|
|
79
79
|
</table>
|
|
80
80
|
|
|
81
|
+
## 📋 Prerequisites
|
|
82
|
+
|
|
83
|
+
<table>
|
|
84
|
+
<tr>
|
|
85
|
+
<td width="50%">
|
|
86
|
+
|
|
87
|
+
### System Requirements
|
|
88
|
+
|
|
89
|
+
**Node.js** version 14.0 or higher is required to run doc-builder.
|
|
90
|
+
|
|
91
|
+
To check if you have Node.js installed:
|
|
92
|
+
```bash
|
|
93
|
+
node --version
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
If you see a version number (e.g., `v18.17.0`), you're ready to go!
|
|
97
|
+
|
|
98
|
+
</td>
|
|
99
|
+
<td width="50%">
|
|
100
|
+
|
|
101
|
+
### Installing Node.js & npm
|
|
102
|
+
|
|
103
|
+
**🍎 macOS**
|
|
104
|
+
- **Recommended**: [Download from nodejs.org](https://nodejs.org/)
|
|
105
|
+
- **Alternative**: Using Homebrew
|
|
106
|
+
```bash
|
|
107
|
+
brew install node
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
**🪟 Windows**
|
|
111
|
+
- **Recommended**: [Download from nodejs.org](https://nodejs.org/)
|
|
112
|
+
- **Alternative**: Using Chocolatey
|
|
113
|
+
```bash
|
|
114
|
+
choco install nodejs
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
</td>
|
|
118
|
+
</tr>
|
|
119
|
+
</table>
|
|
120
|
+
|
|
121
|
+
### Quick Installation Links
|
|
122
|
+
|
|
123
|
+
| Platform | Official Installer | Package Manager |
|
|
124
|
+
|----------|-------------------|-----------------|
|
|
125
|
+
| **macOS** | [Download .pkg](https://nodejs.org/en/download/) | `brew install node` |
|
|
126
|
+
| **Windows** | [Download .msi](https://nodejs.org/en/download/) | `choco install nodejs` |
|
|
127
|
+
| **Linux** | [Download options](https://nodejs.org/en/download/) | `apt install nodejs` or `yum install nodejs` |
|
|
128
|
+
|
|
129
|
+
> 💡 **Note**: npm (Node Package Manager) is included with Node.js installation automatically.
|
|
130
|
+
|
|
81
131
|
## 🚀 Getting Started
|
|
82
132
|
|
|
83
133
|
<table>
|
|
@@ -87,16 +137,16 @@ This aligns perfectly with our mission: beautiful documentation should be access
|
|
|
87
137
|
### Option 1: NPX (No Installation)
|
|
88
138
|
```bash
|
|
89
139
|
# Deploy to Vercel
|
|
90
|
-
npx @knowcode/doc-builder deploy
|
|
140
|
+
npx @knowcode/doc-builder@latest deploy
|
|
91
141
|
|
|
92
142
|
# Build static HTML
|
|
93
|
-
npx @knowcode/doc-builder build
|
|
143
|
+
npx @knowcode/doc-builder@latest build
|
|
94
144
|
|
|
95
145
|
# Development server
|
|
96
|
-
npx @knowcode/doc-builder dev
|
|
146
|
+
npx @knowcode/doc-builder@latest dev
|
|
97
147
|
|
|
98
148
|
# Show help
|
|
99
|
-
npx @knowcode/doc-builder
|
|
149
|
+
npx @knowcode/doc-builder@latest
|
|
100
150
|
```
|
|
101
151
|
*Perfect for trying it out!*
|
|
102
152
|
|
|
@@ -106,7 +156,7 @@ npx @knowcode/doc-builder
|
|
|
106
156
|
### Option 2: NPM Install
|
|
107
157
|
```bash
|
|
108
158
|
# Install as dev dependency
|
|
109
|
-
npm install --save-dev @knowcode/doc-builder
|
|
159
|
+
npm install --save-dev @knowcode/doc-builder@latest
|
|
110
160
|
|
|
111
161
|
# Use shorter commands
|
|
112
162
|
doc-builder deploy
|
|
@@ -124,7 +174,7 @@ doc-builder --help
|
|
|
124
174
|
|
|
125
175
|
The deployment process is now simpler than ever:
|
|
126
176
|
|
|
127
|
-
1. Run `npx @knowcode/doc-builder deploy`
|
|
177
|
+
1. Run `npx @knowcode/doc-builder@latest deploy`
|
|
128
178
|
2. Answer a few simple questions (project name, etc.)
|
|
129
179
|
3. Vercel CLI automatically detects and configures everything
|
|
130
180
|
4. Get your live URL in seconds!
|
|
@@ -356,7 +406,7 @@ When using Claude Code to generate documentation, it typically follows these pat
|
|
|
356
406
|
node --version # Need 14+
|
|
357
407
|
|
|
358
408
|
# Use full package name
|
|
359
|
-
npx @knowcode/doc-builder
|
|
409
|
+
npx @knowcode/doc-builder@latest
|
|
360
410
|
```
|
|
361
411
|
|
|
362
412
|
**"No markdown files found"**
|
|
@@ -367,7 +417,7 @@ npx @knowcode/doc-builder
|
|
|
367
417
|
**Vercel deployment fails**
|
|
368
418
|
```bash
|
|
369
419
|
# Reset Vercel settings
|
|
370
|
-
npx @knowcode/doc-builder reset-vercel
|
|
420
|
+
npx @knowcode/doc-builder@latest reset-vercel
|
|
371
421
|
|
|
372
422
|
# Install Vercel CLI
|
|
373
423
|
npm install -g vercel
|
|
@@ -404,6 +454,14 @@ npx @knowcode/doc-builder@1.5.14
|
|
|
404
454
|
</tr>
|
|
405
455
|
</table>
|
|
406
456
|
|
|
457
|
+
### 🪟 Windows Setup
|
|
458
|
+
|
|
459
|
+
Having issues on Windows? Check our comprehensive [Windows Setup Guide](docs/guides/windows-setup-guide.md) that covers:
|
|
460
|
+
- PowerShell execution policy setup
|
|
461
|
+
- Node.js and npm installation
|
|
462
|
+
- Git for Windows configuration
|
|
463
|
+
- Complete troubleshooting steps
|
|
464
|
+
|
|
407
465
|
### 🔗 Production URL Issues
|
|
408
466
|
|
|
409
467
|
<details>
|
|
@@ -419,12 +477,12 @@ module.exports = {
|
|
|
419
477
|
|
|
420
478
|
**Option 2: CLI Command**
|
|
421
479
|
```bash
|
|
422
|
-
npx @knowcode/doc-builder set-production-url my-docs.vercel.app
|
|
480
|
+
npx @knowcode/doc-builder@latest set-production-url my-docs.vercel.app
|
|
423
481
|
```
|
|
424
482
|
|
|
425
483
|
**Option 3: Deploy Override**
|
|
426
484
|
```bash
|
|
427
|
-
npx @knowcode/doc-builder deploy --production-url my-docs.vercel.app
|
|
485
|
+
npx @knowcode/doc-builder@latest deploy --production-url my-docs.vercel.app
|
|
428
486
|
```
|
|
429
487
|
</details>
|
|
430
488
|
|
|
@@ -682,12 +682,14 @@ th {
|
|
|
682
682
|
background: var(--color-bg-secondary);
|
|
683
683
|
border-bottom: 1px solid var(--color-border-default);
|
|
684
684
|
color: var(--color-text-primary);
|
|
685
|
+
vertical-align: top;
|
|
685
686
|
}
|
|
686
687
|
|
|
687
688
|
td {
|
|
688
689
|
padding: var(--space-3) var(--space-4);
|
|
689
690
|
border-bottom: 1px solid var(--color-border-default);
|
|
690
691
|
color: var(--color-text-primary);
|
|
692
|
+
vertical-align: top;
|
|
691
693
|
}
|
|
692
694
|
|
|
693
695
|
tr:last-child td {
|
package/cli.js
CHANGED
|
@@ -24,7 +24,7 @@ program
|
|
|
24
24
|
.addHelpText('before', `
|
|
25
25
|
${chalk.cyan('🚀 @knowcode/doc-builder')} - Transform your markdown into beautiful documentation sites
|
|
26
26
|
|
|
27
|
-
${chalk.bgGreen.black(' TL;DR ')} ${chalk.green('Just run:')} ${chalk.cyan.bold('npx @knowcode/doc-builder deploy')} ${chalk.green('→ Your docs are live on Vercel!')}
|
|
27
|
+
${chalk.bgGreen.black(' TL;DR ')} ${chalk.green('Just run:')} ${chalk.cyan.bold('npx @knowcode/doc-builder@latest deploy')} ${chalk.green('→ Your docs are live on Vercel!')}
|
|
28
28
|
|
|
29
29
|
${chalk.gray('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━')}
|
|
30
30
|
|
|
@@ -47,18 +47,18 @@ ${chalk.yellow('Quick Start:')}
|
|
|
47
47
|
${chalk.gray('$')} echo "# My Documentation" > docs/README.md
|
|
48
48
|
|
|
49
49
|
${chalk.cyan('2. Build and deploy:')}
|
|
50
|
-
${chalk.gray('$')} npx @knowcode/doc-builder
|
|
51
|
-
${chalk.gray('$')} npx @knowcode/doc-builder deploy
|
|
52
|
-
${chalk.gray('$')} npx @knowcode/doc-builder build
|
|
50
|
+
${chalk.gray('$')} npx @knowcode/doc-builder@latest ${chalk.gray('# Show help and available commands')}
|
|
51
|
+
${chalk.gray('$')} npx @knowcode/doc-builder@latest deploy ${chalk.gray('# Build and deploy to production')}
|
|
52
|
+
${chalk.gray('$')} npx @knowcode/doc-builder@latest build ${chalk.gray('# Build HTML files only')}
|
|
53
53
|
|
|
54
54
|
${chalk.yellow('Troubleshooting npx cache issues:')}
|
|
55
55
|
${chalk.red('If you see an old version after updating:')}
|
|
56
56
|
${chalk.gray('$')} npx clear-npx-cache ${chalk.gray('# Clear the npx cache')}
|
|
57
57
|
${chalk.gray('$')} npx @knowcode/doc-builder@latest ${chalk.gray('# Force latest version')}
|
|
58
|
-
${chalk.gray('$')} npx @knowcode/doc-builder dev
|
|
58
|
+
${chalk.gray('$')} npx @knowcode/doc-builder@latest dev ${chalk.gray('# Start development server')}
|
|
59
59
|
|
|
60
60
|
${chalk.yellow('No docs folder yet?')}
|
|
61
|
-
${chalk.gray('$')} npx @knowcode/doc-builder init --example ${chalk.gray('# Create example docs')}
|
|
61
|
+
${chalk.gray('$')} npx @knowcode/doc-builder@latest init --example ${chalk.gray('# Create example docs')}
|
|
62
62
|
`);
|
|
63
63
|
|
|
64
64
|
// Build command
|
|
@@ -537,7 +537,7 @@ ${chalk.yellow('First-time Vercel Setup:')}
|
|
|
537
537
|
${chalk.gray(' This will open your browser to authenticate')}
|
|
538
538
|
|
|
539
539
|
${chalk.cyan('3. Run doc-builder deploy:')}
|
|
540
|
-
${chalk.gray('$')} npx @knowcode/doc-builder deploy
|
|
540
|
+
${chalk.gray('$')} npx @knowcode/doc-builder@latest deploy
|
|
541
541
|
|
|
542
542
|
You'll be asked several questions:
|
|
543
543
|
|
|
@@ -584,17 +584,17 @@ ${chalk.yellow('First-time Vercel Setup:')}
|
|
|
584
584
|
${chalk.yellow('Deployment Behavior:')}
|
|
585
585
|
${chalk.green.bold('🎯 DEFAULT: All deployments go to PRODUCTION')}
|
|
586
586
|
|
|
587
|
-
${chalk.gray('$')} npx @knowcode/doc-builder ${chalk.gray('# → Shows help (v1.3.0+)')}
|
|
588
|
-
${chalk.gray('$')} npx @knowcode/doc-builder deploy ${chalk.gray('# → yourdocs.vercel.app')}
|
|
589
|
-
${chalk.gray('$')} npx @knowcode/doc-builder deploy --no-prod ${chalk.gray('# → preview URL only')}
|
|
587
|
+
${chalk.gray('$')} npx @knowcode/doc-builder@latest ${chalk.gray('# → Shows help (v1.3.0+)')}
|
|
588
|
+
${chalk.gray('$')} npx @knowcode/doc-builder@latest deploy ${chalk.gray('# → yourdocs.vercel.app')}
|
|
589
|
+
${chalk.gray('$')} npx @knowcode/doc-builder@latest deploy --no-prod ${chalk.gray('# → preview URL only')}
|
|
590
590
|
|
|
591
591
|
${chalk.yellow('When All Else Fails - Delete and Start Fresh:')}
|
|
592
592
|
Sometimes the cleanest solution is to delete the Vercel project:
|
|
593
593
|
|
|
594
594
|
1. Go to your project settings on Vercel
|
|
595
595
|
2. Scroll to bottom and click ${chalk.red('"Delete Project"')}
|
|
596
|
-
3. Run: ${chalk.gray('npx @knowcode/doc-builder reset-vercel')}
|
|
597
|
-
4. Run: ${chalk.gray('npx @knowcode/doc-builder deploy')}
|
|
596
|
+
3. Run: ${chalk.gray('npx @knowcode/doc-builder@latest reset-vercel')}
|
|
597
|
+
4. Run: ${chalk.gray('npx @knowcode/doc-builder@latest deploy')}
|
|
598
598
|
5. Create a NEW project with correct settings
|
|
599
599
|
|
|
600
600
|
This removes all conflicting configurations!
|
|
@@ -636,8 +636,8 @@ ${chalk.yellow('Troubleshooting:')}
|
|
|
636
636
|
${chalk.yellow('The Vercel project was deleted but local config remains.')}
|
|
637
637
|
|
|
638
638
|
${chalk.green('Fix:')}
|
|
639
|
-
${chalk.gray('$')} npx @knowcode/doc-builder reset-vercel
|
|
640
|
-
${chalk.gray('$')} npx @knowcode/doc-builder deploy
|
|
639
|
+
${chalk.gray('$')} npx @knowcode/doc-builder@latest reset-vercel
|
|
640
|
+
${chalk.gray('$')} npx @knowcode/doc-builder@latest deploy
|
|
641
641
|
|
|
642
642
|
This removes old project references and starts fresh
|
|
643
643
|
`)
|
|
@@ -658,7 +658,7 @@ ${chalk.yellow('Troubleshooting:')}
|
|
|
658
658
|
console.log(chalk.gray(' yarn global add vercel'));
|
|
659
659
|
console.log(chalk.gray(' brew install vercel # macOS\n'));
|
|
660
660
|
console.log(chalk.yellow('Then run deployment again:'));
|
|
661
|
-
console.log(chalk.gray(' npx @knowcode/doc-builder deploy\n'));
|
|
661
|
+
console.log(chalk.gray(' npx @knowcode/doc-builder@latest deploy\n'));
|
|
662
662
|
process.exit(1);
|
|
663
663
|
}
|
|
664
664
|
|
|
@@ -742,7 +742,7 @@ ${chalk.yellow('Troubleshooting:')}
|
|
|
742
742
|
console.log(chalk.cyan(` ${deployUrl}`));
|
|
743
743
|
console.log();
|
|
744
744
|
console.log(chalk.gray('To deploy to production, run:'));
|
|
745
|
-
console.log(chalk.gray(' npx @knowcode/doc-builder deploy'));
|
|
745
|
+
console.log(chalk.gray(' npx @knowcode/doc-builder@latest deploy'));
|
|
746
746
|
}
|
|
747
747
|
console.log();
|
|
748
748
|
|
|
@@ -787,7 +787,7 @@ ${chalk.yellow('When to use:')}
|
|
|
787
787
|
fs.removeSync(vercelPath);
|
|
788
788
|
console.log(chalk.green('✅ Vercel configuration reset!'));
|
|
789
789
|
console.log(chalk.gray('\nNow run deployment again:'));
|
|
790
|
-
console.log(chalk.cyan(' npx @knowcode/doc-builder deploy'));
|
|
790
|
+
console.log(chalk.cyan(' npx @knowcode/doc-builder@latest deploy'));
|
|
791
791
|
console.log(chalk.gray('\nThis time:'));
|
|
792
792
|
console.log(chalk.gray('• Create a NEW project (not username/html)'));
|
|
793
793
|
console.log(chalk.gray('• Use a descriptive name like "my-docs"'));
|
|
@@ -822,7 +822,7 @@ ${chalk.yellow('What you\'ll configure:')}
|
|
|
822
822
|
• Open Graph image
|
|
823
823
|
|
|
824
824
|
${chalk.yellow('After setup:')}
|
|
825
|
-
• Run ${chalk.cyan('npx @knowcode/doc-builder build')} to generate with SEO
|
|
825
|
+
• Run ${chalk.cyan('npx @knowcode/doc-builder@latest build')} to generate with SEO
|
|
826
826
|
• Check meta tags in generated HTML files
|
|
827
827
|
• Submit sitemap.xml to search engines
|
|
828
828
|
`)
|
|
@@ -972,7 +972,7 @@ ${chalk.yellow('After setup:')}
|
|
|
972
972
|
if (answers.ogImage) {
|
|
973
973
|
console.log(chalk.gray(`- Add an image at ${answers.ogImage} (1200x630px) for social previews`));
|
|
974
974
|
}
|
|
975
|
-
console.log(chalk.gray('- Run \'npx @knowcode/doc-builder build\' to generate with SEO'));
|
|
975
|
+
console.log(chalk.gray('- Run \'npx @knowcode/doc-builder@latest build\' to generate with SEO'));
|
|
976
976
|
console.log(chalk.gray('- Check your SEO at: https://metatags.io'));
|
|
977
977
|
|
|
978
978
|
} catch (error) {
|
|
@@ -1036,8 +1036,8 @@ ${chalk.yellow('What gets created:')}
|
|
|
1036
1036
|
|
|
1037
1037
|
// Create example files
|
|
1038
1038
|
const exampleFiles = {
|
|
1039
|
-
'README.md': `# Welcome to Your Documentation\n\nThis is an example documentation site created with @knowcode/doc-builder.\n\n## Features\n\n- 📝 Write in Markdown\n- 🎨 Beautiful Notion-inspired design\n- 📊 Mermaid diagram support\n- 🌙 Dark mode\n- 🚀 Deploy to Vercel\n\n## Getting Started\n\n1. Edit this file and add your content\n2. Create new markdown files\n3. Run \`npx @knowcode/doc-builder\` to build and deploy\n\n## Example Diagram\n\n\`\`\`mermaid\ngraph TD\n A[Write Docs] --> B[Build]\n B --> C[Deploy]\n C --> D[Share]\n\`\`\`\n`,
|
|
1040
|
-
'getting-started.md': `# Getting Started\n\n**Generated**: ${new Date().toISOString().split('T')[0]}\n**Status**: Draft\n**Verified**: ❓\n\n## Overview\n\nThis guide will help you get started with your documentation.\n\n## Installation\n\nNo installation required! Just use:\n\n\`\`\`bash\nnpx @knowcode/doc-builder\n\`\`\`\n\n## Writing Documentation\n\n1. Create markdown files in the \`docs\` folder\n2. Use folders to organize your content\n3. Add front matter for metadata\n\n## Building\n\nTo build your documentation:\n\n\`\`\`bash\nnpx @knowcode/doc-builder build\n\`\`\`\n\n## Deployment\n\nDeploy to Vercel:\n\n\`\`\`bash\nnpx @knowcode/doc-builder deploy\n\`\`\`\n`,
|
|
1039
|
+
'README.md': `# Welcome to Your Documentation\n\nThis is an example documentation site created with @knowcode/doc-builder.\n\n## Features\n\n- 📝 Write in Markdown\n- 🎨 Beautiful Notion-inspired design\n- 📊 Mermaid diagram support\n- 🌙 Dark mode\n- 🚀 Deploy to Vercel\n\n## Getting Started\n\n1. Edit this file and add your content\n2. Create new markdown files\n3. Run \`npx @knowcode/doc-builder@latest\` to build and deploy\n\n## Example Diagram\n\n\`\`\`mermaid\ngraph TD\n A[Write Docs] --> B[Build]\n B --> C[Deploy]\n C --> D[Share]\n\`\`\`\n`,
|
|
1040
|
+
'getting-started.md': `# Getting Started\n\n**Generated**: ${new Date().toISOString().split('T')[0]}\n**Status**: Draft\n**Verified**: ❓\n\n## Overview\n\nThis guide will help you get started with your documentation.\n\n## Installation\n\nNo installation required! Just use:\n\n\`\`\`bash\nnpx @knowcode/doc-builder@latest\n\`\`\`\n\n## Writing Documentation\n\n1. Create markdown files in the \`docs\` folder\n2. Use folders to organize your content\n3. Add front matter for metadata\n\n## Building\n\nTo build your documentation:\n\n\`\`\`bash\nnpx @knowcode/doc-builder@latest build\n\`\`\`\n\n## Deployment\n\nDeploy to Vercel:\n\n\`\`\`bash\nnpx @knowcode/doc-builder@latest deploy\n\`\`\`\n`,
|
|
1041
1041
|
'guides/configuration.md': `# Configuration Guide\n\n**Generated**: ${new Date().toISOString().split('T')[0]}\n**Status**: Draft\n**Verified**: ❓\n\n## Overview\n\n@knowcode/doc-builder works with zero configuration, but you can customize it.\n\n## Configuration File\n\nCreate \`doc-builder.config.js\`:\n\n\`\`\`javascript\nmodule.exports = {\n siteName: 'My Documentation',\n siteDescription: 'Documentation for my project',\n \n features: {\n authentication: false,\n changelog: true,\n mermaid: true,\n darkMode: true\n }\n};\n\`\`\`\n\n## Options\n\n### Site Information\n\n- \`siteName\`: Your documentation site name\n- \`siteDescription\`: Brief description\n\n### Directories\n\n- \`docsDir\`: Input directory (default: 'docs')\n- \`outputDir\`: Output directory (default: 'html')\n\n### Features\n\n- \`authentication\`: Enable password protection\n- \`changelog\`: Generate changelog automatically\n- \`mermaid\`: Support for diagrams\n- \`darkMode\`: Dark theme support\n`
|
|
1042
1042
|
};
|
|
1043
1043
|
|
|
@@ -1057,7 +1057,7 @@ ${chalk.yellow('What gets created:')}
|
|
|
1057
1057
|
console.log(chalk.cyan('\\n📚 Example documentation created in docs/ folder'));
|
|
1058
1058
|
console.log(chalk.gray('\\nNext steps:'));
|
|
1059
1059
|
console.log(chalk.gray('1. Edit the example files to add your content'));
|
|
1060
|
-
console.log(chalk.gray('2. Run `npx @knowcode/doc-builder` to build and deploy'));
|
|
1060
|
+
console.log(chalk.gray('2. Run `npx @knowcode/doc-builder@latest` to build and deploy'));
|
|
1061
1061
|
} else {
|
|
1062
1062
|
console.log(chalk.yellow('⚠️ docs/ directory already exists'));
|
|
1063
1063
|
}
|
package/html/README.html
CHANGED
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T15:51:37.097Z",
|
|
66
|
+
"dateModified": "2025-07-22T15:51:37.097Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/README.html"
|
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
|
|
97
97
|
<div class="header-actions">
|
|
98
98
|
<div class="deployment-info">
|
|
99
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
99
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.17">Last updated: Jul 22, 2025, 03:51 PM UTC</span>
|
|
100
100
|
</div>
|
|
101
101
|
|
|
102
102
|
|
|
@@ -161,7 +161,8 @@
|
|
|
161
161
|
<a href="/guides/phosphor-icons-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML."><i class="fas fa-file-alt"></i> Phosphor Icons Guide</a>
|
|
162
162
|
<a href="/guides/seo-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="fas fa-file-alt"></i> Seo Guide</a>
|
|
163
163
|
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
164
|
-
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a
|
|
164
|
+
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a>
|
|
165
|
+
<a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
165
166
|
</nav>
|
|
166
167
|
<div class="resize-handle"></div>
|
|
167
168
|
</aside>
|
|
@@ -255,7 +256,7 @@
|
|
|
255
256
|
<td width="25%">
|
|
256
257
|
|
|
257
258
|
<h3>1️⃣ Initialize</h3>
|
|
258
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder init
|
|
259
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest init
|
|
259
260
|
</code></pre>
|
|
260
261
|
<p><em>Create project structure</em></p>
|
|
261
262
|
</td>
|
|
@@ -274,14 +275,14 @@ Welcome to our docs!
|
|
|
274
275
|
<td width="25%">
|
|
275
276
|
|
|
276
277
|
<h3>3️⃣ Preview</h3>
|
|
277
|
-
<pre><code class="language-bash">npx doc-builder dev
|
|
278
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest dev
|
|
278
279
|
</code></pre>
|
|
279
280
|
<p><em>Live development server</em></p>
|
|
280
281
|
</td>
|
|
281
282
|
<td width="25%">
|
|
282
283
|
|
|
283
284
|
<h3>4️⃣ Deploy</h3>
|
|
284
|
-
<pre><code class="language-bash">npx doc-builder deploy
|
|
285
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
285
286
|
</code></pre>
|
|
286
287
|
<p><em>Push to production</em></p>
|
|
287
288
|
</td>
|
|
@@ -323,7 +324,6 @@ Welcome to our docs!
|
|
|
323
324
|
|
|
324
325
|
<h3>Mermaid Diagrams</h3>
|
|
325
326
|
<div class="mermaid-wrapper">
|
|
326
|
-
<div class="mermaid-title">Diagram</div>
|
|
327
327
|
<div class="mermaid">graph LR
|
|
328
328
|
A[Write] --> B[Build]
|
|
329
329
|
B --> C[Deploy]
|
|
@@ -682,12 +682,14 @@ th {
|
|
|
682
682
|
background: var(--color-bg-secondary);
|
|
683
683
|
border-bottom: 1px solid var(--color-border-default);
|
|
684
684
|
color: var(--color-text-primary);
|
|
685
|
+
vertical-align: top;
|
|
685
686
|
}
|
|
686
687
|
|
|
687
688
|
td {
|
|
688
689
|
padding: var(--space-3) var(--space-4);
|
|
689
690
|
border-bottom: 1px solid var(--color-border-default);
|
|
690
691
|
color: var(--color-text-primary);
|
|
692
|
+
vertical-align: top;
|
|
691
693
|
}
|
|
692
694
|
|
|
693
695
|
tr:last-child td {
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T15:51:37.111Z",
|
|
66
|
+
"dateModified": "2025-07-22T15:51:37.111Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/documentation-index.html"
|
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
|
|
97
97
|
<div class="header-actions">
|
|
98
98
|
<div class="deployment-info">
|
|
99
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
99
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.17">Last updated: Jul 22, 2025, 03:51 PM UTC</span>
|
|
100
100
|
</div>
|
|
101
101
|
|
|
102
102
|
|
|
@@ -161,7 +161,8 @@
|
|
|
161
161
|
<a href="/guides/phosphor-icons-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML."><i class="fas fa-file-alt"></i> Phosphor Icons Guide</a>
|
|
162
162
|
<a href="/guides/seo-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="fas fa-file-alt"></i> Seo Guide</a>
|
|
163
163
|
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
164
|
-
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a
|
|
164
|
+
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a>
|
|
165
|
+
<a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
165
166
|
</nav>
|
|
166
167
|
<div class="resize-handle"></div>
|
|
167
168
|
</aside>
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T15:51:37.115Z",
|
|
66
|
+
"dateModified": "2025-07-22T15:51:37.115Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/guides/authentication-guide.html"
|
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
|
|
103
103
|
<div class="header-actions">
|
|
104
104
|
<div class="deployment-info">
|
|
105
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
105
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.17">Last updated: Jul 22, 2025, 03:51 PM UTC</span>
|
|
106
106
|
</div>
|
|
107
107
|
|
|
108
108
|
|
|
@@ -167,7 +167,8 @@
|
|
|
167
167
|
<a href="/guides/phosphor-icons-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML."><i class="fas fa-file-alt"></i> Phosphor Icons Guide</a>
|
|
168
168
|
<a href="/guides/seo-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="fas fa-file-alt"></i> Seo Guide</a>
|
|
169
169
|
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
170
|
-
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a
|
|
170
|
+
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a>
|
|
171
|
+
<a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
171
172
|
</nav>
|
|
172
173
|
<div class="resize-handle"></div>
|
|
173
174
|
</aside>
|
|
@@ -198,7 +199,6 @@
|
|
|
198
199
|
</ul>
|
|
199
200
|
<h2>How Authentication Works</h2>
|
|
200
201
|
<div class="mermaid-wrapper">
|
|
201
|
-
<div class="mermaid-title">Diagram</div>
|
|
202
202
|
<div class="mermaid">graph TD
|
|
203
203
|
A[User visits page] --> B{Authenticated?}
|
|
204
204
|
B -->|No| C[Redirect to login]
|
|
@@ -244,7 +244,7 @@
|
|
|
244
244
|
</code></pre>
|
|
245
245
|
<h4>2. Using Presets</h4>
|
|
246
246
|
<p>Use the notion-inspired preset which has authentication enabled by default:</p>
|
|
247
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder build --preset notion-inspired
|
|
247
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest build --preset notion-inspired
|
|
248
248
|
</code></pre>
|
|
249
249
|
<p>Default credentials for preset:</p>
|
|
250
250
|
<ul>
|
|
@@ -253,7 +253,7 @@
|
|
|
253
253
|
</ul>
|
|
254
254
|
<h4>3. Command Line</h4>
|
|
255
255
|
<p>Disable authentication for a specific build:</p>
|
|
256
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder build --no-auth
|
|
256
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest build --no-auth
|
|
257
257
|
</code></pre>
|
|
258
258
|
<h3>Configuration Options</h3>
|
|
259
259
|
<table>
|
|
@@ -288,7 +288,7 @@
|
|
|
288
288
|
<h3>For Site Administrators</h3>
|
|
289
289
|
<ol>
|
|
290
290
|
<li><strong>Set Credentials</strong>: Configure username/password in <code>doc-builder.config.js</code></li>
|
|
291
|
-
<li><strong>Build Site</strong>: Run <code>npx @knowcode/doc-builder build</code></li>
|
|
291
|
+
<li><strong>Build Site</strong>: Run <code>npx @knowcode/doc-builder@latest build</code></li>
|
|
292
292
|
<li><strong>Deploy</strong>: Upload to your hosting provider</li>
|
|
293
293
|
<li><strong>Share Credentials</strong>: Provide login details to authorized users</li>
|
|
294
294
|
</ol>
|
|
@@ -407,10 +407,10 @@ module.exports = {
|
|
|
407
407
|
</code></pre>
|
|
408
408
|
<h3>Build and Deploy</h3>
|
|
409
409
|
<pre><code class="language-bash"># Build with authentication
|
|
410
|
-
npx @knowcode/doc-builder build
|
|
410
|
+
npx @knowcode/doc-builder@latest build
|
|
411
411
|
|
|
412
412
|
# Deploy to Vercel
|
|
413
|
-
npx @knowcode/doc-builder deploy
|
|
413
|
+
npx @knowcode/doc-builder@latest deploy
|
|
414
414
|
</code></pre>
|
|
415
415
|
<h3>User Instructions</h3>
|
|
416
416
|
<p>Email to team:</p>
|