@knowcode/doc-builder 1.5.4 → 1.5.6
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/CHANGELOG.md +39 -0
- package/CLAUDE.md +3 -0
- package/README.md +41 -0
- package/cli.js +173 -0
- package/html/README.html +12 -11
- package/html/documentation-index.html +12 -11
- package/html/guides/authentication-guide.html +12 -11
- package/html/guides/claude-workflow-guide.html +12 -11
- package/html/guides/documentation-standards.html +12 -11
- package/html/guides/google-site-verification-guide.html +12 -11
- package/html/guides/seo-guide.html +12 -11
- package/html/guides/seo-optimization-guide.html +493 -0
- package/html/guides/troubleshooting-guide.html +12 -11
- package/html/index.html +12 -11
- package/html/sitemap.xml +20 -14
- package/html/vercel-cli-setup-guide.html +12 -11
- package/html/vercel-first-time-setup-guide.html +12 -11
- package/lib/config.js +4 -0
- package/lib/core-builder.js +40 -19
- package/lib/seo.js +44 -7
- package/package.json +2 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,45 @@ 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.6] - 2025-07-22
|
|
9
|
+
|
|
10
|
+
### Fixed
|
|
11
|
+
- Fixed missing gray-matter import in cli.js causing seo-check command to fail
|
|
12
|
+
- Resolved "path argument must be string" error when running seo-check
|
|
13
|
+
|
|
14
|
+
## [1.5.5] - 2025-07-22
|
|
15
|
+
|
|
16
|
+
### Added
|
|
17
|
+
- **Front Matter Support**: Parse YAML front matter for page-specific SEO customization
|
|
18
|
+
- **SEO Check Command**: New `seo-check` command to analyze and report SEO issues
|
|
19
|
+
- **Smart Description Extraction**: Intelligent extraction of intro paragraphs for better descriptions
|
|
20
|
+
- **Enhanced Title Generation**: SEO-optimized titles with customizable templates
|
|
21
|
+
- **Page-specific Keywords**: Support for front matter keywords plus auto-extraction
|
|
22
|
+
- **Comprehensive SEO Guide**: Detailed documentation for SEO optimization
|
|
23
|
+
|
|
24
|
+
### Changed
|
|
25
|
+
- Improved `generateDescription` with smart mode for better meta descriptions
|
|
26
|
+
- Title generation now respects 50-60 character limit with smart truncation
|
|
27
|
+
- Keywords can be defined per-page via front matter
|
|
28
|
+
- SEO configuration expanded with new options
|
|
29
|
+
|
|
30
|
+
### Features
|
|
31
|
+
- **Front Matter SEO**: Add custom title, description, and keywords per page
|
|
32
|
+
- **Title Templates**: Configure title format with `{pageTitle} | {siteName}` patterns
|
|
33
|
+
- **Auto Keywords**: Automatically extract relevant keywords from content
|
|
34
|
+
- **SEO Analysis**: Run `doc-builder seo-check` to find and fix SEO issues
|
|
35
|
+
- **Smart Defaults**: Intelligent fallbacks for missing SEO data
|
|
36
|
+
|
|
37
|
+
### Configuration
|
|
38
|
+
```javascript
|
|
39
|
+
seo: {
|
|
40
|
+
titleTemplate: '{pageTitle} | {siteName}',
|
|
41
|
+
autoKeywords: true,
|
|
42
|
+
keywordLimit: 7,
|
|
43
|
+
descriptionFallback: 'smart'
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
8
47
|
## [1.5.4] - 2025-07-22
|
|
9
48
|
|
|
10
49
|
### Added
|
package/CLAUDE.md
CHANGED
|
@@ -312,6 +312,9 @@ build(config).then(() => {
|
|
|
312
312
|
|
|
313
313
|
MIT License - See LICENSE file for details
|
|
314
314
|
|
|
315
|
+
### NPM Features Documentation
|
|
316
|
+
- When we add new features - add it to the NPM documented bullet point features - if its a big feature give it a section
|
|
317
|
+
|
|
315
318
|
---
|
|
316
319
|
|
|
317
320
|
**Note**: This project was extracted from the cybersolstice monorepo on 2025-07-21 with full git history preservation.
|
package/README.md
CHANGED
|
@@ -49,6 +49,9 @@ This aligns perfectly with our mission: beautiful documentation should be access
|
|
|
49
49
|
- 🔄 **Live Reload** - Development server with hot reloading
|
|
50
50
|
- ☁️ **Vercel Integration** - One-command deployment to Vercel
|
|
51
51
|
- 🔍 **SEO Optimized** - Meta tags, Open Graph, Twitter Cards, and structured data
|
|
52
|
+
- ✅ **Google Site Verification** - Easy Google Search Console verification with CLI command
|
|
53
|
+
- 📝 **Front Matter SEO** - Per-page titles, descriptions, and keywords with YAML front matter
|
|
54
|
+
- 🎯 **SEO Analysis** - Built-in `seo-check` command to optimize your content
|
|
52
55
|
- 📦 **Self-Contained** - No configuration or setup required
|
|
53
56
|
- 🤖 **Claude Code Ready** - Optimized for AI-generated documentation workflows
|
|
54
57
|
|
|
@@ -147,6 +150,44 @@ npx @knowcode/doc-builder set-production-url https://my-custom-domain.com
|
|
|
147
150
|
|
|
148
151
|
This is useful when you have a custom domain or Vercel alias that differs from the auto-detected URL.
|
|
149
152
|
|
|
153
|
+
### google-verify
|
|
154
|
+
|
|
155
|
+
Add Google site verification meta tag for Google Search Console:
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
# Add your verification code
|
|
159
|
+
npx @knowcode/doc-builder google-verify YOUR_VERIFICATION_CODE
|
|
160
|
+
|
|
161
|
+
# Example
|
|
162
|
+
npx @knowcode/doc-builder google-verify FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
This adds the verification meta tag to all generated HTML pages, allowing you to verify ownership in Google Search Console. See the [Google Site Verification Guide](docs/guides/google-site-verification-guide.md) for complete details.
|
|
166
|
+
|
|
167
|
+
### seo-check
|
|
168
|
+
|
|
169
|
+
Analyze and optimize your documentation's SEO:
|
|
170
|
+
|
|
171
|
+
```bash
|
|
172
|
+
# Check all pages for SEO issues
|
|
173
|
+
npx @knowcode/doc-builder seo-check
|
|
174
|
+
|
|
175
|
+
# Check a specific page
|
|
176
|
+
npx @knowcode/doc-builder seo-check docs/guide.md
|
|
177
|
+
|
|
178
|
+
# Future: Auto-fix common issues
|
|
179
|
+
npx @knowcode/doc-builder seo-check --fix
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
This command analyzes:
|
|
183
|
+
- Title length and optimization (50-60 characters)
|
|
184
|
+
- Meta descriptions (140-160 characters)
|
|
185
|
+
- Keywords usage and relevance
|
|
186
|
+
- Front matter SEO fields
|
|
187
|
+
- Content quality signals
|
|
188
|
+
|
|
189
|
+
See the [SEO Optimization Guide](docs/guides/seo-optimization-guide.md) for best practices.
|
|
190
|
+
|
|
150
191
|
### setup-seo
|
|
151
192
|
Interactive SEO configuration wizard:
|
|
152
193
|
```bash
|
package/cli.js
CHANGED
|
@@ -10,7 +10,9 @@ const { build } = require('./lib/builder');
|
|
|
10
10
|
const { startDevServer } = require('./lib/dev-server');
|
|
11
11
|
const { deployToVercel, setupVercelProject, prepareDeployment } = require('./lib/deploy');
|
|
12
12
|
const { loadConfig, createDefaultConfig } = require('./lib/config');
|
|
13
|
+
const { generateDescription } = require('./lib/seo');
|
|
13
14
|
const { execSync } = require('child_process');
|
|
15
|
+
const matter = require('gray-matter');
|
|
14
16
|
|
|
15
17
|
// Package info
|
|
16
18
|
const packageJson = require('./package.json');
|
|
@@ -191,6 +193,177 @@ ${chalk.yellow('Get your verification code from Google Search Console.')}
|
|
|
191
193
|
}
|
|
192
194
|
});
|
|
193
195
|
|
|
196
|
+
// SEO Check command
|
|
197
|
+
program
|
|
198
|
+
.command('seo-check [path]')
|
|
199
|
+
.description('Analyze SEO for your documentation pages')
|
|
200
|
+
.option('-c, --config <path>', 'path to config file (default: doc-builder.config.js)')
|
|
201
|
+
.option('--fix', 'auto-fix common SEO issues')
|
|
202
|
+
.addHelpText('after', `
|
|
203
|
+
${chalk.yellow('Examples:')}
|
|
204
|
+
${chalk.gray('$')} doc-builder seo-check ${chalk.gray('# Check all pages')}
|
|
205
|
+
${chalk.gray('$')} doc-builder seo-check docs/guide.md ${chalk.gray('# Check specific page')}
|
|
206
|
+
${chalk.gray('$')} doc-builder seo-check --fix ${chalk.gray('# Auto-fix issues')}
|
|
207
|
+
|
|
208
|
+
${chalk.yellow('This command analyzes:')}
|
|
209
|
+
• Title length and optimization (50-60 characters)
|
|
210
|
+
• Meta descriptions (140-160 characters)
|
|
211
|
+
• Keywords usage and relevance
|
|
212
|
+
• Front matter SEO fields
|
|
213
|
+
• Duplicate content issues
|
|
214
|
+
`)
|
|
215
|
+
.action(async (filePath, options) => {
|
|
216
|
+
try {
|
|
217
|
+
const config = await loadConfig(options.config);
|
|
218
|
+
const docsDir = path.resolve(config.docsDir || 'docs');
|
|
219
|
+
|
|
220
|
+
console.log(chalk.cyan('🔍 Analyzing SEO...'));
|
|
221
|
+
|
|
222
|
+
// Get files to check
|
|
223
|
+
let files = [];
|
|
224
|
+
if (filePath) {
|
|
225
|
+
const fullPath = path.resolve(filePath);
|
|
226
|
+
if (await fs.pathExists(fullPath)) {
|
|
227
|
+
files = [fullPath];
|
|
228
|
+
} else {
|
|
229
|
+
console.error(chalk.red(`File not found: ${filePath}`));
|
|
230
|
+
process.exit(1);
|
|
231
|
+
}
|
|
232
|
+
} else {
|
|
233
|
+
// Get all markdown files
|
|
234
|
+
const getAllFiles = async (dir) => {
|
|
235
|
+
const results = [];
|
|
236
|
+
const items = await fs.readdir(dir);
|
|
237
|
+
for (const item of items) {
|
|
238
|
+
const fullPath = path.join(dir, item);
|
|
239
|
+
const stat = await fs.stat(fullPath);
|
|
240
|
+
if (stat.isDirectory() && !item.startsWith('.')) {
|
|
241
|
+
results.push(...await getAllFiles(fullPath));
|
|
242
|
+
} else if (item.endsWith('.md')) {
|
|
243
|
+
results.push(fullPath);
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
return results;
|
|
247
|
+
};
|
|
248
|
+
files = await getAllFiles(docsDir);
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
// Analyze each file
|
|
252
|
+
const issues = [];
|
|
253
|
+
const suggestions = [];
|
|
254
|
+
|
|
255
|
+
for (const file of files) {
|
|
256
|
+
const content = await fs.readFile(file, 'utf-8');
|
|
257
|
+
const { data: frontMatter, content: mainContent } = matter(content);
|
|
258
|
+
const relativePath = path.relative(docsDir, file);
|
|
259
|
+
|
|
260
|
+
// Extract current metadata
|
|
261
|
+
const h1Match = mainContent.match(/^#\s+(.+)$/m);
|
|
262
|
+
const h1Title = h1Match ? h1Match[1] : null;
|
|
263
|
+
const title = frontMatter.title || h1Title || path.basename(file, '.md');
|
|
264
|
+
const description = frontMatter.description || generateDescription(mainContent, 'smart');
|
|
265
|
+
const keywords = frontMatter.keywords || [];
|
|
266
|
+
|
|
267
|
+
// Check title
|
|
268
|
+
const titleLength = title.length;
|
|
269
|
+
if (titleLength > 60) {
|
|
270
|
+
issues.push({
|
|
271
|
+
file: relativePath,
|
|
272
|
+
type: 'title',
|
|
273
|
+
message: `Title too long (${titleLength} chars, max 60)`,
|
|
274
|
+
current: title,
|
|
275
|
+
suggestion: title.substring(0, 57) + '...'
|
|
276
|
+
});
|
|
277
|
+
} else if (titleLength < 30) {
|
|
278
|
+
suggestions.push({
|
|
279
|
+
file: relativePath,
|
|
280
|
+
type: 'title',
|
|
281
|
+
message: `Title might be too short (${titleLength} chars, ideal 50-60)`
|
|
282
|
+
});
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
// Check description
|
|
286
|
+
const descLength = description.length;
|
|
287
|
+
if (descLength > 160) {
|
|
288
|
+
issues.push({
|
|
289
|
+
file: relativePath,
|
|
290
|
+
type: 'description',
|
|
291
|
+
message: `Description too long (${descLength} chars, max 160)`,
|
|
292
|
+
current: description,
|
|
293
|
+
suggestion: description.substring(0, 157) + '...'
|
|
294
|
+
});
|
|
295
|
+
} else if (descLength < 120) {
|
|
296
|
+
suggestions.push({
|
|
297
|
+
file: relativePath,
|
|
298
|
+
type: 'description',
|
|
299
|
+
message: `Description might be too short (${descLength} chars, ideal 140-160)`
|
|
300
|
+
});
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
// Check keywords
|
|
304
|
+
if (keywords.length === 0 && !frontMatter.description) {
|
|
305
|
+
suggestions.push({
|
|
306
|
+
file: relativePath,
|
|
307
|
+
type: 'keywords',
|
|
308
|
+
message: 'No keywords defined in front matter'
|
|
309
|
+
});
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
// Check for front matter
|
|
313
|
+
if (!frontMatter.title && !frontMatter.description) {
|
|
314
|
+
suggestions.push({
|
|
315
|
+
file: relativePath,
|
|
316
|
+
type: 'frontmatter',
|
|
317
|
+
message: 'No SEO front matter found'
|
|
318
|
+
});
|
|
319
|
+
}
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
// Display results
|
|
323
|
+
console.log(`\n${chalk.cyan('📊 SEO Analysis Complete')}\n`);
|
|
324
|
+
console.log(`Analyzed ${files.length} files\n`);
|
|
325
|
+
|
|
326
|
+
if (issues.length === 0 && suggestions.length === 0) {
|
|
327
|
+
console.log(chalk.green('✅ No SEO issues found!'));
|
|
328
|
+
} else {
|
|
329
|
+
if (issues.length > 0) {
|
|
330
|
+
console.log(chalk.red(`❌ Found ${issues.length} issues:\n`));
|
|
331
|
+
issues.forEach(issue => {
|
|
332
|
+
console.log(chalk.red(` ${issue.file}:`));
|
|
333
|
+
console.log(chalk.yellow(` ${issue.message}`));
|
|
334
|
+
if (issue.suggestion) {
|
|
335
|
+
console.log(chalk.gray(` Suggestion: ${issue.suggestion.substring(0, 50)}...`));
|
|
336
|
+
}
|
|
337
|
+
console.log('');
|
|
338
|
+
});
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
if (suggestions.length > 0) {
|
|
342
|
+
console.log(chalk.yellow(`💡 ${suggestions.length} suggestions:\n`));
|
|
343
|
+
suggestions.forEach(suggestion => {
|
|
344
|
+
console.log(chalk.yellow(` ${suggestion.file}: ${suggestion.message}`));
|
|
345
|
+
});
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
console.log(`\n${chalk.cyan('💡 Tips:')}`);
|
|
349
|
+
console.log(' • Add front matter to customize SEO per page');
|
|
350
|
+
console.log(' • Keep titles between 50-60 characters');
|
|
351
|
+
console.log(' • Write descriptions between 140-160 characters');
|
|
352
|
+
console.log(' • Include relevant keywords in front matter');
|
|
353
|
+
console.log(`\n${chalk.gray('Example front matter:')}`);
|
|
354
|
+
console.log(chalk.gray('---'));
|
|
355
|
+
console.log(chalk.gray('title: "Your SEO Optimized Title Here"'));
|
|
356
|
+
console.log(chalk.gray('description: "A compelling description between 140-160 characters that includes keywords and encourages clicks."'));
|
|
357
|
+
console.log(chalk.gray('keywords: ["keyword1", "keyword2", "keyword3"]'));
|
|
358
|
+
console.log(chalk.gray('---'));
|
|
359
|
+
}
|
|
360
|
+
|
|
361
|
+
} catch (error) {
|
|
362
|
+
console.error(chalk.red('Failed to analyze SEO:'), error.message);
|
|
363
|
+
process.exit(1);
|
|
364
|
+
}
|
|
365
|
+
});
|
|
366
|
+
|
|
194
367
|
// Set Production URL command
|
|
195
368
|
program
|
|
196
369
|
.command('set-production-url <url>')
|
package/html/README.html
CHANGED
|
@@ -3,19 +3,19 @@
|
|
|
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>@knowcode/doc-builder
|
|
6
|
+
<meta name="description" content="> Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling.">
|
|
7
|
+
<title>@knowcode/doc-builder | Doc Builder</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
10
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, your, knowcode
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, your, knowcode">
|
|
11
11
|
<meta name="robots" content="index, follow">
|
|
12
12
|
<link rel="canonical" href="https://doc-builder-delta.vercel.app/README.html">
|
|
13
13
|
|
|
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/README.html">
|
|
17
|
-
<meta property="og:title" content="@knowcode/doc-builder
|
|
18
|
-
<meta property="og:description" content="
|
|
17
|
+
<meta property="og:title" content="@knowcode/doc-builder | Doc Builder">
|
|
18
|
+
<meta property="og:description" content="> Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling.">
|
|
19
19
|
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
20
|
<meta property="og:site_name" content="Doc Builder">
|
|
21
21
|
<meta property="og:locale" content="en_US">
|
|
@@ -24,8 +24,8 @@
|
|
|
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="@knowcode/doc-builder
|
|
28
|
-
<meta name="twitter:description" content="
|
|
27
|
+
<meta name="twitter:title" content="@knowcode/doc-builder | Doc Builder">
|
|
28
|
+
<meta name="twitter:description" content="> Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling.">
|
|
29
29
|
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
30
|
|
|
31
31
|
<!-- Custom Meta Tags -->
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
"@context": "https://schema.org",
|
|
52
52
|
"@type": "TechArticle",
|
|
53
53
|
"headline": "@knowcode/doc-builder",
|
|
54
|
-
"description": "
|
|
54
|
+
"description": "> Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling.",
|
|
55
55
|
"author": {
|
|
56
56
|
"@type": "Person",
|
|
57
57
|
"name": "Lindsay Smith"
|
|
@@ -61,8 +61,8 @@
|
|
|
61
61
|
"name": "Knowcode Ltd",
|
|
62
62
|
"url": "https://knowcode.tech"
|
|
63
63
|
},
|
|
64
|
-
"datePublished": "2025-07-
|
|
65
|
-
"dateModified": "2025-07-
|
|
64
|
+
"datePublished": "2025-07-22T08:09:57.857Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:09:57.857Z",
|
|
66
66
|
"mainEntityOfPage": {
|
|
67
67
|
"@type": "WebPage",
|
|
68
68
|
"@id": "https://doc-builder-delta.vercel.app/README.html"
|
|
@@ -95,7 +95,7 @@
|
|
|
95
95
|
|
|
96
96
|
<div class="header-actions">
|
|
97
97
|
<div class="deployment-info">
|
|
98
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
98
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
|
|
99
99
|
</div>
|
|
100
100
|
|
|
101
101
|
|
|
@@ -158,6 +158,7 @@
|
|
|
158
158
|
<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>
|
|
159
159
|
<a href="/guides/google-site-verification-guide.html" class="nav-item" data-tooltip="Google Search Console verification allows you to: Monitor your site's performance in Google Search Submit sitemaps for better indexing View search..."><i class="fas fa-file-alt"></i> Google Site Verification Guide</a>
|
|
160
160
|
<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>
|
|
161
|
+
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
161
162
|
<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>
|
|
162
163
|
</nav>
|
|
163
164
|
<div class="resize-handle"></div>
|
|
@@ -3,19 +3,19 @@
|
|
|
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>Documentation Index
|
|
6
|
+
<meta name="description" content="Generated: 2025-07-21 18:00 UTC">
|
|
7
|
+
<title>Documentation Index | Doc Builder</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
10
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, guide, claude
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, guide, claude">
|
|
11
11
|
<meta name="robots" content="index, follow">
|
|
12
12
|
<link rel="canonical" href="https://doc-builder-delta.vercel.app/documentation-index.html">
|
|
13
13
|
|
|
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/documentation-index.html">
|
|
17
|
-
<meta property="og:title" content="Documentation Index
|
|
18
|
-
<meta property="og:description" content="
|
|
17
|
+
<meta property="og:title" content="Documentation Index | Doc Builder">
|
|
18
|
+
<meta property="og:description" content="Generated: 2025-07-21 18:00 UTC">
|
|
19
19
|
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
20
|
<meta property="og:site_name" content="Doc Builder">
|
|
21
21
|
<meta property="og:locale" content="en_US">
|
|
@@ -24,8 +24,8 @@
|
|
|
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="Documentation Index
|
|
28
|
-
<meta name="twitter:description" content="
|
|
27
|
+
<meta name="twitter:title" content="Documentation Index | Doc Builder">
|
|
28
|
+
<meta name="twitter:description" content="Generated: 2025-07-21 18:00 UTC">
|
|
29
29
|
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
30
|
|
|
31
31
|
<!-- Custom Meta Tags -->
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
"@context": "https://schema.org",
|
|
52
52
|
"@type": "TechArticle",
|
|
53
53
|
"headline": "Documentation Index",
|
|
54
|
-
"description": "
|
|
54
|
+
"description": "Generated: 2025-07-21 18:00 UTC",
|
|
55
55
|
"author": {
|
|
56
56
|
"@type": "Person",
|
|
57
57
|
"name": "Lindsay Smith"
|
|
@@ -61,8 +61,8 @@
|
|
|
61
61
|
"name": "Knowcode Ltd",
|
|
62
62
|
"url": "https://knowcode.tech"
|
|
63
63
|
},
|
|
64
|
-
"datePublished": "2025-07-
|
|
65
|
-
"dateModified": "2025-07-
|
|
64
|
+
"datePublished": "2025-07-22T08:09:57.871Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:09:57.871Z",
|
|
66
66
|
"mainEntityOfPage": {
|
|
67
67
|
"@type": "WebPage",
|
|
68
68
|
"@id": "https://doc-builder-delta.vercel.app/documentation-index.html"
|
|
@@ -95,7 +95,7 @@
|
|
|
95
95
|
|
|
96
96
|
<div class="header-actions">
|
|
97
97
|
<div class="deployment-info">
|
|
98
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
98
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
|
|
99
99
|
</div>
|
|
100
100
|
|
|
101
101
|
|
|
@@ -158,6 +158,7 @@
|
|
|
158
158
|
<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>
|
|
159
159
|
<a href="/guides/google-site-verification-guide.html" class="nav-item" data-tooltip="Google Search Console verification allows you to: Monitor your site's performance in Google Search Submit sitemaps for better indexing View search..."><i class="fas fa-file-alt"></i> Google Site Verification Guide</a>
|
|
160
160
|
<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>
|
|
161
|
+
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
161
162
|
<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>
|
|
162
163
|
</nav>
|
|
163
164
|
<div class="resize-handle"></div>
|
|
@@ -3,19 +3,19 @@
|
|
|
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="Generated: 2025-07-21 18:30 UTC">
|
|
7
|
+
<title>Authentication Guide for @knowcode/doc-builder | Doc Builder</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
10
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, authentication, login
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, authentication, login">
|
|
11
11
|
<meta name="robots" content="index, follow">
|
|
12
12
|
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/authentication-guide.html">
|
|
13
13
|
|
|
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/authentication-guide.html">
|
|
17
|
-
<meta property="og:title" content="Authentication Guide for @knowcode/doc-builder
|
|
18
|
-
<meta property="og:description" content="
|
|
17
|
+
<meta property="og:title" content="Authentication Guide for @knowcode/doc-builder | Doc Builder">
|
|
18
|
+
<meta property="og:description" content="Generated: 2025-07-21 18:30 UTC">
|
|
19
19
|
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
20
|
<meta property="og:site_name" content="Doc Builder">
|
|
21
21
|
<meta property="og:locale" content="en_US">
|
|
@@ -24,8 +24,8 @@
|
|
|
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="Authentication Guide for @knowcode/doc-builder
|
|
28
|
-
<meta name="twitter:description" content="
|
|
27
|
+
<meta name="twitter:title" content="Authentication Guide for @knowcode/doc-builder | Doc Builder">
|
|
28
|
+
<meta name="twitter:description" content="Generated: 2025-07-21 18:30 UTC">
|
|
29
29
|
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
30
|
|
|
31
31
|
<!-- Custom Meta Tags -->
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
"@context": "https://schema.org",
|
|
52
52
|
"@type": "TechArticle",
|
|
53
53
|
"headline": "Authentication Guide for @knowcode/doc-builder",
|
|
54
|
-
"description": "
|
|
54
|
+
"description": "Generated: 2025-07-21 18:30 UTC",
|
|
55
55
|
"author": {
|
|
56
56
|
"@type": "Person",
|
|
57
57
|
"name": "Lindsay Smith"
|
|
@@ -61,8 +61,8 @@
|
|
|
61
61
|
"name": "Knowcode Ltd",
|
|
62
62
|
"url": "https://knowcode.tech"
|
|
63
63
|
},
|
|
64
|
-
"datePublished": "2025-07-
|
|
65
|
-
"dateModified": "2025-07-
|
|
64
|
+
"datePublished": "2025-07-22T08:09:57.875Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:09:57.875Z",
|
|
66
66
|
"mainEntityOfPage": {
|
|
67
67
|
"@type": "WebPage",
|
|
68
68
|
"@id": "https://doc-builder-delta.vercel.app/guides/authentication-guide.html"
|
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
|
|
102
102
|
<div class="header-actions">
|
|
103
103
|
<div class="deployment-info">
|
|
104
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
104
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
|
|
105
105
|
</div>
|
|
106
106
|
|
|
107
107
|
|
|
@@ -164,6 +164,7 @@
|
|
|
164
164
|
<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>
|
|
165
165
|
<a href="/guides/google-site-verification-guide.html" class="nav-item" data-tooltip="Google Search Console verification allows you to: Monitor your site's performance in Google Search Submit sitemaps for better indexing View search..."><i class="fas fa-file-alt"></i> Google Site Verification Guide</a>
|
|
166
166
|
<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>
|
|
167
|
+
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
167
168
|
<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>
|
|
168
169
|
</nav>
|
|
169
170
|
<div class="resize-handle"></div>
|
|
@@ -3,19 +3,19 @@
|
|
|
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="Generated: 2025-07-21 10:00 UTC">
|
|
7
|
+
<title>Claude + CLAUDE.md Documentation Workflow Guide</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
10
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, claude, workflow
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, claude, workflow">
|
|
11
11
|
<meta name="robots" content="index, follow">
|
|
12
12
|
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/claude-workflow-guide.html">
|
|
13
13
|
|
|
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/claude-workflow-guide.html">
|
|
17
|
-
<meta property="og:title" content="Claude + CLAUDE.md Documentation Workflow Guide
|
|
18
|
-
<meta property="og:description" content="
|
|
17
|
+
<meta property="og:title" content="Claude + CLAUDE.md Documentation Workflow Guide">
|
|
18
|
+
<meta property="og:description" content="Generated: 2025-07-21 10:00 UTC">
|
|
19
19
|
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
20
|
<meta property="og:site_name" content="Doc Builder">
|
|
21
21
|
<meta property="og:locale" content="en_US">
|
|
@@ -24,8 +24,8 @@
|
|
|
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="Claude + CLAUDE.md Documentation Workflow Guide
|
|
28
|
-
<meta name="twitter:description" content="
|
|
27
|
+
<meta name="twitter:title" content="Claude + CLAUDE.md Documentation Workflow Guide">
|
|
28
|
+
<meta name="twitter:description" content="Generated: 2025-07-21 10:00 UTC">
|
|
29
29
|
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
30
|
|
|
31
31
|
<!-- Custom Meta Tags -->
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
"@context": "https://schema.org",
|
|
52
52
|
"@type": "TechArticle",
|
|
53
53
|
"headline": "Claude + CLAUDE.md Documentation Workflow Guide",
|
|
54
|
-
"description": "
|
|
54
|
+
"description": "Generated: 2025-07-21 10:00 UTC",
|
|
55
55
|
"author": {
|
|
56
56
|
"@type": "Person",
|
|
57
57
|
"name": "Lindsay Smith"
|
|
@@ -61,8 +61,8 @@
|
|
|
61
61
|
"name": "Knowcode Ltd",
|
|
62
62
|
"url": "https://knowcode.tech"
|
|
63
63
|
},
|
|
64
|
-
"datePublished": "2025-07-
|
|
65
|
-
"dateModified": "2025-07-
|
|
64
|
+
"datePublished": "2025-07-22T08:09:57.879Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:09:57.879Z",
|
|
66
66
|
"mainEntityOfPage": {
|
|
67
67
|
"@type": "WebPage",
|
|
68
68
|
"@id": "https://doc-builder-delta.vercel.app/guides/claude-workflow-guide.html"
|
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
|
|
102
102
|
<div class="header-actions">
|
|
103
103
|
<div class="deployment-info">
|
|
104
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
104
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
|
|
105
105
|
</div>
|
|
106
106
|
|
|
107
107
|
|
|
@@ -164,6 +164,7 @@
|
|
|
164
164
|
<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>
|
|
165
165
|
<a href="/guides/google-site-verification-guide.html" class="nav-item" data-tooltip="Google Search Console verification allows you to: Monitor your site's performance in Google Search Submit sitemaps for better indexing View search..."><i class="fas fa-file-alt"></i> Google Site Verification Guide</a>
|
|
166
166
|
<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>
|
|
167
|
+
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
167
168
|
<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>
|
|
168
169
|
</nav>
|
|
169
170
|
<div class="resize-handle"></div>
|