@knowcode/doc-builder 1.4.24 → 1.5.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.
- package/.claude/settings.local.json +4 -1
- package/CHANGELOG.md +27 -0
- package/README.md +57 -7
- package/cli.js +251 -2
- package/doc-builder.config.js +38 -0
- package/html/README.html +71 -5
- package/html/claude-workflow-guide.html +71 -5
- package/html/documentation-index.html +77 -5
- package/html/guides/authentication-guide.html +77 -5
- package/html/guides/documentation-standards.html +77 -5
- package/html/guides/seo-guide.html +557 -0
- package/html/guides/troubleshooting-guide.html +77 -5
- package/html/index.html +71 -5
- package/html/robots.txt +5 -0
- package/html/sitemap.xml +69 -0
- package/html/vercel-cli-setup-guide.html +452 -0
- package/html/vercel-first-time-setup-guide.html +419 -0
- package/lib/config.js +39 -1
- package/lib/core-builder.js +103 -5
- package/lib/deploy.js +93 -36
- package/lib/seo.js +359 -0
- package/package.json +1 -1
|
@@ -3,8 +3,30 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="
|
|
7
|
-
<title>Claude + CLAUDE.md Documentation Workflow Guide -
|
|
6
|
+
<meta name="description" content="Claude + CLAUDE.">
|
|
7
|
+
<title>Claude + CLAUDE.md Documentation Workflow Guide - Doc Builder</title>
|
|
8
|
+
|
|
9
|
+
<meta name="author" content="Lindsay Smith">
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, claude, workflow, step">
|
|
11
|
+
<meta name="robots" content="index, follow">
|
|
12
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/claude-workflow-guide.html">
|
|
13
|
+
|
|
14
|
+
<!-- Open Graph / Facebook -->
|
|
15
|
+
<meta property="og:type" content="article">
|
|
16
|
+
<meta property="og:url" content="https://doc-builder-delta.vercel.app/claude-workflow-guide.html">
|
|
17
|
+
<meta property="og:title" content="Claude + CLAUDE.md Documentation Workflow Guide - Doc Builder">
|
|
18
|
+
<meta property="og:description" content="Claude + CLAUDE.">
|
|
19
|
+
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
+
<meta property="og:site_name" content="Doc Builder">
|
|
21
|
+
<meta property="og:locale" content="en_US">
|
|
22
|
+
|
|
23
|
+
<!-- Twitter Card -->
|
|
24
|
+
<meta name="twitter:card" content="summary_large_image">
|
|
25
|
+
<meta name="twitter:site" content="@planbbackups">
|
|
26
|
+
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
+
<meta name="twitter:title" content="Claude + CLAUDE.md Documentation Workflow Guide - Doc Builder">
|
|
28
|
+
<meta name="twitter:description" content="Claude + CLAUDE.">
|
|
29
|
+
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
8
30
|
|
|
9
31
|
<!-- Fonts -->
|
|
10
32
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
@@ -20,16 +42,57 @@
|
|
|
20
42
|
|
|
21
43
|
<!-- Favicon -->
|
|
22
44
|
<link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>📚</text></svg>">
|
|
45
|
+
|
|
46
|
+
<script type="application/ld+json">
|
|
47
|
+
{
|
|
48
|
+
"@context": "https://schema.org",
|
|
49
|
+
"@type": "TechArticle",
|
|
50
|
+
"headline": "Claude + CLAUDE.md Documentation Workflow Guide",
|
|
51
|
+
"description": "Claude + CLAUDE.",
|
|
52
|
+
"author": {
|
|
53
|
+
"@type": "Person",
|
|
54
|
+
"name": "Lindsay Smith"
|
|
55
|
+
},
|
|
56
|
+
"publisher": {
|
|
57
|
+
"@type": "Organization",
|
|
58
|
+
"name": "KnowCode",
|
|
59
|
+
"url": "https://knowcode.com"
|
|
60
|
+
},
|
|
61
|
+
"datePublished": "2025-07-21T20:24:35.114Z",
|
|
62
|
+
"dateModified": "2025-07-21T20:24:35.114Z",
|
|
63
|
+
"mainEntityOfPage": {
|
|
64
|
+
"@type": "WebPage",
|
|
65
|
+
"@id": "https://doc-builder-delta.vercel.app/claude-workflow-guide.html"
|
|
66
|
+
},
|
|
67
|
+
"breadcrumb": {
|
|
68
|
+
"@type": "BreadcrumbList",
|
|
69
|
+
"itemListElement": [
|
|
70
|
+
{
|
|
71
|
+
"@type": "ListItem",
|
|
72
|
+
"position": 1,
|
|
73
|
+
"name": "Doc Builder",
|
|
74
|
+
"item": "https://doc-builder-delta.vercel.app"
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"@type": "ListItem",
|
|
78
|
+
"position": 2,
|
|
79
|
+
"name": "Claude Workflow Guide",
|
|
80
|
+
"item": "https://doc-builder-delta.vercel.app/claude-workflow-guide.html"
|
|
81
|
+
}
|
|
82
|
+
]
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
</script>
|
|
23
86
|
</head>
|
|
24
87
|
<body>
|
|
25
88
|
<!-- Header -->
|
|
26
89
|
<header class="header">
|
|
27
90
|
<div class="header-content">
|
|
28
|
-
<a href="/index.html" class="logo">
|
|
91
|
+
<a href="/index.html" class="logo">Doc Builder</a>
|
|
29
92
|
|
|
30
93
|
<div class="header-actions">
|
|
31
94
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.4.
|
|
95
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.26">Last updated: Jul 21, 2025, 08:24 PM UTC</span>
|
|
33
96
|
</div>
|
|
34
97
|
|
|
35
98
|
|
|
@@ -80,7 +143,9 @@
|
|
|
80
143
|
<div class="nav-content" >
|
|
81
144
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
82
145
|
<a href="/claude-workflow-guide.html" class="nav-item active" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
|
|
83
|
-
<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
|
|
146
|
+
<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>
|
|
147
|
+
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
148
|
+
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you'll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
84
149
|
<div class="nav-section" data-level="1">
|
|
85
150
|
<a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
|
|
86
151
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -88,6 +153,7 @@
|
|
|
88
153
|
<div class="nav-content collapsed" id="nav-guides-1">
|
|
89
154
|
<a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic..."><i class="fas fa-file-alt"></i> Authentication Guide</a>
|
|
90
155
|
<a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
|
|
156
|
+
<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>
|
|
91
157
|
<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></div></div>
|
|
92
158
|
</nav>
|
|
93
159
|
<div class="resize-handle"></div>
|
|
@@ -3,8 +3,30 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="Documentation
|
|
7
|
-
<title>Documentation Index -
|
|
6
|
+
<meta name="description" content="Documentation Index.">
|
|
7
|
+
<title>Documentation Index - Doc Builder</title>
|
|
8
|
+
|
|
9
|
+
<meta name="author" content="Lindsay Smith">
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, guide, claude, standards, document">
|
|
11
|
+
<meta name="robots" content="index, follow">
|
|
12
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/documentation-index.html">
|
|
13
|
+
|
|
14
|
+
<!-- Open Graph / Facebook -->
|
|
15
|
+
<meta property="og:type" content="article">
|
|
16
|
+
<meta property="og:url" content="https://doc-builder-delta.vercel.app/documentation-index.html">
|
|
17
|
+
<meta property="og:title" content="Documentation Index - Doc Builder">
|
|
18
|
+
<meta property="og:description" content="Documentation Index.">
|
|
19
|
+
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
+
<meta property="og:site_name" content="Doc Builder">
|
|
21
|
+
<meta property="og:locale" content="en_US">
|
|
22
|
+
|
|
23
|
+
<!-- Twitter Card -->
|
|
24
|
+
<meta name="twitter:card" content="summary_large_image">
|
|
25
|
+
<meta name="twitter:site" content="@planbbackups">
|
|
26
|
+
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
+
<meta name="twitter:title" content="Documentation Index - Doc Builder">
|
|
28
|
+
<meta name="twitter:description" content="Documentation Index.">
|
|
29
|
+
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
8
30
|
|
|
9
31
|
<!-- Fonts -->
|
|
10
32
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
@@ -20,16 +42,57 @@
|
|
|
20
42
|
|
|
21
43
|
<!-- Favicon -->
|
|
22
44
|
<link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>📚</text></svg>">
|
|
45
|
+
|
|
46
|
+
<script type="application/ld+json">
|
|
47
|
+
{
|
|
48
|
+
"@context": "https://schema.org",
|
|
49
|
+
"@type": "TechArticle",
|
|
50
|
+
"headline": "Documentation Index",
|
|
51
|
+
"description": "Documentation Index.",
|
|
52
|
+
"author": {
|
|
53
|
+
"@type": "Person",
|
|
54
|
+
"name": "Lindsay Smith"
|
|
55
|
+
},
|
|
56
|
+
"publisher": {
|
|
57
|
+
"@type": "Organization",
|
|
58
|
+
"name": "KnowCode",
|
|
59
|
+
"url": "https://knowcode.com"
|
|
60
|
+
},
|
|
61
|
+
"datePublished": "2025-07-21T20:24:35.117Z",
|
|
62
|
+
"dateModified": "2025-07-21T20:24:35.117Z",
|
|
63
|
+
"mainEntityOfPage": {
|
|
64
|
+
"@type": "WebPage",
|
|
65
|
+
"@id": "https://doc-builder-delta.vercel.app/documentation-index.html"
|
|
66
|
+
},
|
|
67
|
+
"breadcrumb": {
|
|
68
|
+
"@type": "BreadcrumbList",
|
|
69
|
+
"itemListElement": [
|
|
70
|
+
{
|
|
71
|
+
"@type": "ListItem",
|
|
72
|
+
"position": 1,
|
|
73
|
+
"name": "Doc Builder",
|
|
74
|
+
"item": "https://doc-builder-delta.vercel.app"
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"@type": "ListItem",
|
|
78
|
+
"position": 2,
|
|
79
|
+
"name": "Documentation Index",
|
|
80
|
+
"item": "https://doc-builder-delta.vercel.app/documentation-index.html"
|
|
81
|
+
}
|
|
82
|
+
]
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
</script>
|
|
23
86
|
</head>
|
|
24
87
|
<body>
|
|
25
88
|
<!-- Header -->
|
|
26
89
|
<header class="header">
|
|
27
90
|
<div class="header-content">
|
|
28
|
-
<a href="/index.html" class="logo">
|
|
91
|
+
<a href="/index.html" class="logo">Doc Builder</a>
|
|
29
92
|
|
|
30
93
|
<div class="header-actions">
|
|
31
94
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.4.
|
|
95
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.26">Last updated: Jul 21, 2025, 08:24 PM UTC</span>
|
|
33
96
|
</div>
|
|
34
97
|
|
|
35
98
|
|
|
@@ -80,7 +143,9 @@
|
|
|
80
143
|
<div class="nav-content" >
|
|
81
144
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
82
145
|
<a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
|
|
83
|
-
<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
|
|
146
|
+
<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>
|
|
147
|
+
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
148
|
+
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you'll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
84
149
|
<div class="nav-section" data-level="1">
|
|
85
150
|
<a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
|
|
86
151
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -88,6 +153,7 @@
|
|
|
88
153
|
<div class="nav-content collapsed" id="nav-guides-1">
|
|
89
154
|
<a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic..."><i class="fas fa-file-alt"></i> Authentication Guide</a>
|
|
90
155
|
<a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
|
|
156
|
+
<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>
|
|
91
157
|
<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></div></div>
|
|
92
158
|
</nav>
|
|
93
159
|
<div class="resize-handle"></div>
|
|
@@ -108,6 +174,7 @@
|
|
|
108
174
|
└── guides/ # How-to guides and standards
|
|
109
175
|
├── authentication-guide.md # Authentication setup and usage
|
|
110
176
|
├── documentation-standards.md # Documentation standards
|
|
177
|
+
├── seo-guide.md # SEO features and configuration
|
|
111
178
|
└── troubleshooting-guide.md # Common issues and solutions
|
|
112
179
|
</code></pre>
|
|
113
180
|
<h2>Documentation Categories</h2>
|
|
@@ -156,6 +223,11 @@
|
|
|
156
223
|
<td>Setting up password protection</td>
|
|
157
224
|
</tr>
|
|
158
225
|
<tr>
|
|
226
|
+
<td>SEO Guide</td>
|
|
227
|
+
<td><a href="./guides/seo-guide.md">guides/seo-guide.md</a></td>
|
|
228
|
+
<td>SEO features and configuration</td>
|
|
229
|
+
</tr>
|
|
230
|
+
<tr>
|
|
159
231
|
<td>Troubleshooting Guide</td>
|
|
160
232
|
<td><a href="./guides/troubleshooting-guide.md">guides/troubleshooting-guide.md</a></td>
|
|
161
233
|
<td>Common issues and solutions</td>
|
|
@@ -3,8 +3,30 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="
|
|
7
|
-
<title>Authentication Guide for @knowcode/doc-builder -
|
|
6
|
+
<meta name="description" content="Authentication Guide for @knowcode/doc-builder.">
|
|
7
|
+
<title>Authentication Guide for @knowcode/doc-builder - Doc Builder</title>
|
|
8
|
+
|
|
9
|
+
<meta name="author" content="Lindsay Smith">
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, authentication, login, access, credentials, page">
|
|
11
|
+
<meta name="robots" content="index, follow">
|
|
12
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/authentication-guide.html">
|
|
13
|
+
|
|
14
|
+
<!-- Open Graph / Facebook -->
|
|
15
|
+
<meta property="og:type" content="article">
|
|
16
|
+
<meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/authentication-guide.html">
|
|
17
|
+
<meta property="og:title" content="Authentication Guide for @knowcode/doc-builder - Doc Builder">
|
|
18
|
+
<meta property="og:description" content="Authentication Guide for @knowcode/doc-builder.">
|
|
19
|
+
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
+
<meta property="og:site_name" content="Doc Builder">
|
|
21
|
+
<meta property="og:locale" content="en_US">
|
|
22
|
+
|
|
23
|
+
<!-- Twitter Card -->
|
|
24
|
+
<meta name="twitter:card" content="summary_large_image">
|
|
25
|
+
<meta name="twitter:site" content="@planbbackups">
|
|
26
|
+
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
+
<meta name="twitter:title" content="Authentication Guide for @knowcode/doc-builder - Doc Builder">
|
|
28
|
+
<meta name="twitter:description" content="Authentication Guide for @knowcode/doc-builder.">
|
|
29
|
+
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
8
30
|
|
|
9
31
|
<!-- Fonts -->
|
|
10
32
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
@@ -20,16 +42,63 @@
|
|
|
20
42
|
|
|
21
43
|
<!-- Favicon -->
|
|
22
44
|
<link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>📚</text></svg>">
|
|
45
|
+
|
|
46
|
+
<script type="application/ld+json">
|
|
47
|
+
{
|
|
48
|
+
"@context": "https://schema.org",
|
|
49
|
+
"@type": "TechArticle",
|
|
50
|
+
"headline": "Authentication Guide for @knowcode/doc-builder",
|
|
51
|
+
"description": "Authentication Guide for @knowcode/doc-builder.",
|
|
52
|
+
"author": {
|
|
53
|
+
"@type": "Person",
|
|
54
|
+
"name": "Lindsay Smith"
|
|
55
|
+
},
|
|
56
|
+
"publisher": {
|
|
57
|
+
"@type": "Organization",
|
|
58
|
+
"name": "KnowCode",
|
|
59
|
+
"url": "https://knowcode.com"
|
|
60
|
+
},
|
|
61
|
+
"datePublished": "2025-07-21T20:24:35.119Z",
|
|
62
|
+
"dateModified": "2025-07-21T20:24:35.119Z",
|
|
63
|
+
"mainEntityOfPage": {
|
|
64
|
+
"@type": "WebPage",
|
|
65
|
+
"@id": "https://doc-builder-delta.vercel.app/guides/authentication-guide.html"
|
|
66
|
+
},
|
|
67
|
+
"breadcrumb": {
|
|
68
|
+
"@type": "BreadcrumbList",
|
|
69
|
+
"itemListElement": [
|
|
70
|
+
{
|
|
71
|
+
"@type": "ListItem",
|
|
72
|
+
"position": 1,
|
|
73
|
+
"name": "Doc Builder",
|
|
74
|
+
"item": "https://doc-builder-delta.vercel.app"
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"@type": "ListItem",
|
|
78
|
+
"position": 2,
|
|
79
|
+
"name": "Guides",
|
|
80
|
+
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"@type": "ListItem",
|
|
84
|
+
"position": 3,
|
|
85
|
+
"name": "Authentication Guide",
|
|
86
|
+
"item": "https://doc-builder-delta.vercel.app/guides/authentication-guide.html"
|
|
87
|
+
}
|
|
88
|
+
]
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
</script>
|
|
23
92
|
</head>
|
|
24
93
|
<body>
|
|
25
94
|
<!-- Header -->
|
|
26
95
|
<header class="header">
|
|
27
96
|
<div class="header-content">
|
|
28
|
-
<a href="/index.html" class="logo">
|
|
97
|
+
<a href="/index.html" class="logo">Doc Builder</a>
|
|
29
98
|
|
|
30
99
|
<div class="header-actions">
|
|
31
100
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.4.
|
|
101
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.26">Last updated: Jul 21, 2025, 08:24 PM UTC</span>
|
|
33
102
|
</div>
|
|
34
103
|
|
|
35
104
|
|
|
@@ -80,7 +149,9 @@
|
|
|
80
149
|
<div class="nav-content" >
|
|
81
150
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
82
151
|
<a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
|
|
83
|
-
<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
|
|
152
|
+
<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>
|
|
153
|
+
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
154
|
+
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you'll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
84
155
|
<div class="nav-section" data-level="1">
|
|
85
156
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
86
157
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -88,6 +159,7 @@
|
|
|
88
159
|
<div class="nav-content" id="nav-guides-1">
|
|
89
160
|
<a href="/guides/authentication-guide.html" class="nav-item active" data-tooltip="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic..."><i class="fas fa-file-alt"></i> Authentication Guide</a>
|
|
90
161
|
<a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
|
|
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>
|
|
91
163
|
<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></div></div>
|
|
92
164
|
</nav>
|
|
93
165
|
<div class="resize-handle"></div>
|
|
@@ -3,8 +3,30 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="
|
|
7
|
-
<title>Document Standards for @knowcode/doc-builder -
|
|
6
|
+
<meta name="description" content="Document Standards for @knowcode/doc-builder.">
|
|
7
|
+
<title>Document Standards for @knowcode/doc-builder - Doc Builder</title>
|
|
8
|
+
|
|
9
|
+
<meta name="author" content="Lindsay Smith">
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, document, use, include, changes">
|
|
11
|
+
<meta name="robots" content="index, follow">
|
|
12
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/documentation-standards.html">
|
|
13
|
+
|
|
14
|
+
<!-- Open Graph / Facebook -->
|
|
15
|
+
<meta property="og:type" content="article">
|
|
16
|
+
<meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/documentation-standards.html">
|
|
17
|
+
<meta property="og:title" content="Document Standards for @knowcode/doc-builder - Doc Builder">
|
|
18
|
+
<meta property="og:description" content="Document Standards for @knowcode/doc-builder.">
|
|
19
|
+
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
+
<meta property="og:site_name" content="Doc Builder">
|
|
21
|
+
<meta property="og:locale" content="en_US">
|
|
22
|
+
|
|
23
|
+
<!-- Twitter Card -->
|
|
24
|
+
<meta name="twitter:card" content="summary_large_image">
|
|
25
|
+
<meta name="twitter:site" content="@planbbackups">
|
|
26
|
+
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
+
<meta name="twitter:title" content="Document Standards for @knowcode/doc-builder - Doc Builder">
|
|
28
|
+
<meta name="twitter:description" content="Document Standards for @knowcode/doc-builder.">
|
|
29
|
+
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
8
30
|
|
|
9
31
|
<!-- Fonts -->
|
|
10
32
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
@@ -20,16 +42,63 @@
|
|
|
20
42
|
|
|
21
43
|
<!-- Favicon -->
|
|
22
44
|
<link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>📚</text></svg>">
|
|
45
|
+
|
|
46
|
+
<script type="application/ld+json">
|
|
47
|
+
{
|
|
48
|
+
"@context": "https://schema.org",
|
|
49
|
+
"@type": "TechArticle",
|
|
50
|
+
"headline": "Document Standards for @knowcode/doc-builder",
|
|
51
|
+
"description": "Document Standards for @knowcode/doc-builder.",
|
|
52
|
+
"author": {
|
|
53
|
+
"@type": "Person",
|
|
54
|
+
"name": "Lindsay Smith"
|
|
55
|
+
},
|
|
56
|
+
"publisher": {
|
|
57
|
+
"@type": "Organization",
|
|
58
|
+
"name": "KnowCode",
|
|
59
|
+
"url": "https://knowcode.com"
|
|
60
|
+
},
|
|
61
|
+
"datePublished": "2025-07-21T20:24:35.123Z",
|
|
62
|
+
"dateModified": "2025-07-21T20:24:35.123Z",
|
|
63
|
+
"mainEntityOfPage": {
|
|
64
|
+
"@type": "WebPage",
|
|
65
|
+
"@id": "https://doc-builder-delta.vercel.app/guides/documentation-standards.html"
|
|
66
|
+
},
|
|
67
|
+
"breadcrumb": {
|
|
68
|
+
"@type": "BreadcrumbList",
|
|
69
|
+
"itemListElement": [
|
|
70
|
+
{
|
|
71
|
+
"@type": "ListItem",
|
|
72
|
+
"position": 1,
|
|
73
|
+
"name": "Doc Builder",
|
|
74
|
+
"item": "https://doc-builder-delta.vercel.app"
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"@type": "ListItem",
|
|
78
|
+
"position": 2,
|
|
79
|
+
"name": "Guides",
|
|
80
|
+
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"@type": "ListItem",
|
|
84
|
+
"position": 3,
|
|
85
|
+
"name": "Documentation Standards",
|
|
86
|
+
"item": "https://doc-builder-delta.vercel.app/guides/documentation-standards.html"
|
|
87
|
+
}
|
|
88
|
+
]
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
</script>
|
|
23
92
|
</head>
|
|
24
93
|
<body>
|
|
25
94
|
<!-- Header -->
|
|
26
95
|
<header class="header">
|
|
27
96
|
<div class="header-content">
|
|
28
|
-
<a href="/index.html" class="logo">
|
|
97
|
+
<a href="/index.html" class="logo">Doc Builder</a>
|
|
29
98
|
|
|
30
99
|
<div class="header-actions">
|
|
31
100
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.4.
|
|
101
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.26">Last updated: Jul 21, 2025, 08:24 PM UTC</span>
|
|
33
102
|
</div>
|
|
34
103
|
|
|
35
104
|
|
|
@@ -80,7 +149,9 @@
|
|
|
80
149
|
<div class="nav-content" >
|
|
81
150
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
82
151
|
<a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
|
|
83
|
-
<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
|
|
152
|
+
<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>
|
|
153
|
+
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
154
|
+
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you'll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
84
155
|
<div class="nav-section" data-level="1">
|
|
85
156
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
86
157
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -88,6 +159,7 @@
|
|
|
88
159
|
<div class="nav-content" id="nav-guides-1">
|
|
89
160
|
<a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic..."><i class="fas fa-file-alt"></i> Authentication Guide</a>
|
|
90
161
|
<a href="/guides/documentation-standards.html" class="nav-item active" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
|
|
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>
|
|
91
163
|
<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></div></div>
|
|
92
164
|
</nav>
|
|
93
165
|
<div class="resize-handle"></div>
|