@knowcode/doc-builder 1.8.7 → 1.9.1

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.
Files changed (48) hide show
  1. package/.claude/settings.local.json +2 -1
  2. package/CHANGELOG.md +27 -0
  3. package/README.md +2 -0
  4. package/assets/css/notion-style.css +141 -0
  5. package/assets/js/main.js +76 -0
  6. package/html/README.html +41 -149
  7. package/html/css/notion-style.css +13 -253
  8. package/html/documentation-index.html +24 -127
  9. package/html/guides/authentication-default-change.html +15 -130
  10. package/html/guides/authentication-guide.html +27 -141
  11. package/html/guides/claude-workflow-guide.html +30 -137
  12. package/html/guides/documentation-standards.html +19 -133
  13. package/html/guides/image-modal-guide.html +381 -0
  14. package/html/guides/phosphor-icons-guide.html +35 -150
  15. package/html/guides/private-directory-authentication.html +15 -130
  16. package/html/guides/public-site-deployment.html +15 -130
  17. package/html/guides/search-engine-verification-guide.html +15 -130
  18. package/html/guides/seo-guide.html +15 -130
  19. package/html/guides/seo-optimization-guide.html +46 -159
  20. package/html/guides/troubleshooting-guide.html +27 -141
  21. package/html/guides/windows-setup-guide.html +46 -161
  22. package/html/image-modal-test.html +189 -0
  23. package/html/index.html +41 -149
  24. package/html/js/auth.js +39 -118
  25. package/html/js/main.js +25 -183
  26. package/html/private/cache-control-anti-pattern.html +20 -135
  27. package/html/private/launch/README.html +23 -144
  28. package/html/private/launch/auth-cleanup-summary.html +32 -153
  29. package/html/private/launch/bubble-plugin-specification.html +15 -136
  30. package/html/private/launch/go-to-market-strategy.html +17 -138
  31. package/html/private/launch/launch-announcements.html +31 -151
  32. package/html/private/launch/vercel-deployment-auth-setup.html +17 -138
  33. package/html/private/next-steps-walkthrough.html +21 -136
  34. package/html/private/supabase-auth-implementation-completed.html +29 -143
  35. package/html/private/supabase-auth-implementation-plan.html +22 -136
  36. package/html/private/supabase-auth-integration-plan.html +29 -142
  37. package/html/private/supabase-auth-setup-guide.html +24 -139
  38. package/html/private/test-private-doc.html +15 -130
  39. package/html/private/user-management-tooling.html +15 -130
  40. package/html/prompts/markdown-document-standards.html +288 -0
  41. package/html/sitemap.xml +56 -44
  42. package/html/vercel-cli-setup-guide.html +19 -128
  43. package/html/vercel-first-time-setup-guide.html +16 -125
  44. package/lib/core-builder.js +1 -0
  45. package/lib/emoji-mapper.js +25 -0
  46. package/package/assets/css/notion-style.css +432 -135
  47. package/package/assets/js/main.js +259 -25
  48. package/package.json +1 -1
@@ -3,41 +3,14 @@
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="This document provides comprehensive documentation for the Supabase user management system created for doc-builder authenticated sites.">
7
- <title>User Management Tooling | @knowcode/doc-builder</title>
8
-
9
- <meta name="author" content="Lindsay Smith">
10
- <meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, user, supabase">
11
- <meta name="robots" content="index, follow">
12
- <link rel="canonical" href="https://doc-builder-delta.vercel.app/private/user-management-tooling.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/private/user-management-tooling.html">
17
- <meta property="og:title" content="User Management Tooling | @knowcode/doc-builder">
18
- <meta property="og:description" content="This document provides comprehensive documentation for the Supabase user management system created for doc-builder authenticated sites.">
19
- <meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
20
- <meta property="og:site_name" content="@knowcode/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="User Management Tooling | @knowcode/doc-builder">
28
- <meta name="twitter:description" content="This document provides comprehensive documentation for the Supabase user management system created for doc-builder authenticated sites.">
29
- <meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
30
-
31
- <!-- Custom Meta Tags -->
32
- <meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
33
- <meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
6
+ <meta name="description" content="Beautiful documentation with the least effort possible">
7
+ <title>User Management Tooling - @knowcode/doc-builder</title>
34
8
 
35
9
  <!-- Fonts -->
36
10
  <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
37
11
 
38
12
  <!-- Icons -->
39
13
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
40
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
41
14
 
42
15
  <!-- Mermaid -->
43
16
  <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
@@ -45,90 +18,8 @@
45
18
  <!-- Styles -->
46
19
  <link rel="stylesheet" href="/css/notion-style.css">
47
20
 
48
-
49
- <!-- Hide content until auth check -->
50
- <style>
51
- body {
52
- visibility: hidden;
53
- opacity: 0;
54
- transition: opacity 0.3s ease;
55
- }
56
- body.authenticated {
57
- visibility: visible;
58
- opacity: 1;
59
- }
60
- /* Show login/logout pages immediately */
61
- body.auth-page {
62
- visibility: visible;
63
- opacity: 1;
64
- }
65
- /* Style auth button consistently */
66
- .auth-btn {
67
- background: none;
68
- border: none;
69
- color: var(--text-secondary);
70
- cursor: pointer;
71
- padding: 0.5rem;
72
- border-radius: 0.5rem;
73
- transition: all 0.2s;
74
- font-size: 1.1rem;
75
- }
76
- .auth-btn:hover {
77
- background: var(--bg-secondary);
78
- color: var(--text-primary);
79
- }
80
- </style>
81
-
82
-
83
21
  <!-- Favicon -->
84
- <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>">
85
-
86
- <script type="application/ld+json">
87
- {
88
- "@context": "https://schema.org",
89
- "@type": "TechArticle",
90
- "headline": "User Management Tooling",
91
- "description": "This document provides comprehensive documentation for the Supabase user management system created for doc-builder authenticated sites.",
92
- "author": {
93
- "@type": "Person",
94
- "name": "Lindsay Smith"
95
- },
96
- "publisher": {
97
- "@type": "Organization",
98
- "name": "Knowcode Ltd",
99
- "url": "https://knowcode.tech"
100
- },
101
- "datePublished": "2025-07-26T16:10:10.656Z",
102
- "dateModified": "2025-07-26T16:10:10.656Z",
103
- "mainEntityOfPage": {
104
- "@type": "WebPage",
105
- "@id": "https://doc-builder-delta.vercel.app/private/user-management-tooling.html"
106
- },
107
- "breadcrumb": {
108
- "@type": "BreadcrumbList",
109
- "itemListElement": [
110
- {
111
- "@type": "ListItem",
112
- "position": 1,
113
- "name": "@knowcode/doc-builder",
114
- "item": "https://doc-builder-delta.vercel.app"
115
- },
116
- {
117
- "@type": "ListItem",
118
- "position": 2,
119
- "name": "Private",
120
- "item": "https://doc-builder-delta.vercel.app/private/"
121
- },
122
- {
123
- "@type": "ListItem",
124
- "position": 3,
125
- "name": "User Management Tooling",
126
- "item": "https://doc-builder-delta.vercel.app/private/user-management-tooling.html"
127
- }
128
- ]
129
- }
130
- }
131
- </script>
22
+ <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>">
132
23
  </head>
133
24
  <body>
134
25
  <!-- Header -->
@@ -138,14 +29,10 @@
138
29
 
139
30
  <div class="header-actions">
140
31
  <div class="deployment-info">
141
- <span class="deployment-date" title="Built with doc-builder v1.8.6">Last updated: Jul 26, 2025, 04:10 PM UTC</span>
32
+ <span class="deployment-date" title="Built with doc-builder v1.4.21">Last updated: Jul 27, 2025, 08:32 AM UTC</span>
142
33
  </div>
143
34
 
144
35
 
145
- <a href="../../login.html" class="auth-btn" title="Login/Logout">
146
- <i class="fas fa-sign-in-alt"></i>
147
- </a>
148
-
149
36
 
150
37
  <button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
151
38
  <i class="fas fa-moon"></i>
@@ -193,6 +80,7 @@
193
80
  <div class="nav-content" >
194
81
  <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
195
82
  <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>
83
+ <a href="/image-modal-test.html" class="nav-item" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="fas fa-file-alt"></i> Image Modal Test</a>
196
84
  <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
197
85
  <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
198
86
  <div class="nav-section" data-level="1">
@@ -204,6 +92,7 @@
204
92
  <a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase - a secure, scalable authentication platform."><i class="fas fa-file-alt"></i> Authentication Guide</a>
205
93
  <a href="/guides/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>
206
94
  <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>
95
+ <a href="/guides/image-modal-guide.html" class="nav-item" data-tooltip="When users click on any image in your generated documentation, it opens in a professional modal overlay with: Full-screen viewing experience Smooth..."><i class="fas fa-file-alt"></i> Image Modal Guide</a>
207
96
  <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>
208
97
  <a href="/guides/private-directory-authentication.html" class="nav-item" data-tooltip="The @knowcode/doc-builder provides flexible authentication options to protect your documentation."><i class="fas fa-file-alt"></i> Private Directory Authentication</a>
209
98
  <a href="/guides/public-site-deployment.html" class="nav-item" data-tooltip="The @knowcode/doc-builder now supports deploying public documentation sites without authentication."><i class="fas fa-file-alt"></i> Public Site Deployment</a>
@@ -212,7 +101,7 @@
212
101
  <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>
213
102
  <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>
214
103
  <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>
215
- <div class="nav-section private-nav" data-level="1">
104
+ <div class="nav-section" data-level="1">
216
105
  <a class="nav-title collapsible expanded" href="#" data-target="nav-private-1" >
217
106
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
218
107
  </a>
@@ -225,7 +114,7 @@
225
114
  <a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="fas fa-file-alt"></i> Supabase Auth Setup Guide</a>
226
115
  <a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="fas fa-file-alt"></i> Test Private Doc</a>
227
116
  <a href="/private/user-management-tooling.html" class="nav-item active" data-tooltip="The user management system is a set of tools designed to manage user access to Supabase-authenticated documentation sites built with."><i class="fas fa-file-alt"></i> User Management Tooling</a></div></div>
228
- <div class="nav-section private-nav" data-level="2">
117
+ <div class="nav-section" data-level="2">
229
118
  <a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
230
119
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
231
120
  </a>
@@ -236,6 +125,12 @@
236
125
  <a href="/private/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy &amp; Product Launch Plan."><i class="fas fa-file-alt"></i> Go To Market Strategy</a>
237
126
  <a href="/private/launch/launch-announcements.html" class="nav-item" data-tooltip="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels."><i class="fas fa-file-alt"></i> Launch Announcements</a>
238
127
  <a href="/private/launch/vercel-deployment-auth-setup.html" class="nav-item" data-tooltip="Vercel Deployment Authentication Setup Guide."><i class="fas fa-file-alt"></i> Vercel Deployment Auth Setup</a></div></div>
128
+ <div class="nav-section" data-level="1">
129
+ <a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
130
+ <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Prompts
131
+ </a>
132
+ <div class="nav-content collapsed" id="nav-prompts-1">
133
+ <a href="/prompts/markdown-document-standards.html" class="nav-item" data-tooltip="Detailed introduction to the topic..."><i class="fas fa-file-alt"></i> Markdown Document Standards</a></div></div>
239
134
  </nav>
240
135
  <div class="resize-handle"></div>
241
136
  </aside>
@@ -565,17 +460,7 @@ DATABASE_URL=postgresql://postgres:[password]@db.[project-id].supabase.co:5432/p
565
460
  </div>
566
461
 
567
462
  <!-- Scripts -->
568
- <script>
569
- // Pass configuration to frontend
570
- window.docBuilderConfig = {
571
- features: {
572
- showPdfDownload: true,
573
- menuDefaultOpen: false
574
- }
575
- };
576
- </script>
577
463
  <script src="/js/main.js"></script>
578
- <script src="https://unpkg.com/@supabase/supabase-js@2"></script>
579
- <script src="/js/auth.js"></script>
464
+
580
465
  </body>
581
466
  </html>
@@ -0,0 +1,288 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <meta name="description" content="Beautiful documentation with the least effort possible">
7
+ <title>Markdown Document Standards Prompt - @knowcode/doc-builder</title>
8
+
9
+ <!-- Fonts -->
10
+ <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
11
+
12
+ <!-- Icons -->
13
+ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
14
+
15
+ <!-- Mermaid -->
16
+ <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
17
+
18
+ <!-- Styles -->
19
+ <link rel="stylesheet" href="/css/notion-style.css">
20
+
21
+ <!-- Favicon -->
22
+ <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>">
23
+ </head>
24
+ <body>
25
+ <!-- Header -->
26
+ <header class="header">
27
+ <div class="header-content">
28
+ <a href="/index.html" class="logo">@knowcode/doc-builder</a>
29
+
30
+ <div class="header-actions">
31
+ <div class="deployment-info">
32
+ <span class="deployment-date" title="Built with doc-builder v1.4.21">Last updated: Jul 27, 2025, 08:32 AM UTC</span>
33
+ </div>
34
+
35
+
36
+
37
+ <button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
38
+ <i class="fas fa-moon"></i>
39
+ </button>
40
+
41
+ <button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
42
+ <i class="fas fa-bars"></i>
43
+ </button>
44
+ </div>
45
+ </div>
46
+ </header>
47
+
48
+ <!-- Preview Banner -->
49
+ <div id="preview-banner" class="preview-banner">
50
+ <div class="banner-content">
51
+ <i class="fas fa-exclamation-triangle banner-icon"></i>
52
+ <span class="banner-text">This documentation is a preview version - some content may be incomplete</span>
53
+ <button id="dismiss-banner" class="banner-dismiss" aria-label="Dismiss banner">
54
+ <i class="fas fa-times"></i>
55
+ </button>
56
+ </div>
57
+ </div>
58
+
59
+ <!-- Breadcrumbs -->
60
+ <nav class="breadcrumbs" id="breadcrumbs">
61
+ <!-- Breadcrumbs will be generated by JavaScript -->
62
+ </nav>
63
+
64
+ <!-- Main Content -->
65
+ <div class="main-wrapper">
66
+ <!-- Sidebar -->
67
+ <aside class="sidebar">
68
+ <div class="sidebar-header">
69
+ <div class="filter-box">
70
+ <input type="text" placeholder="Filter items..." class="filter-input" id="nav-filter">
71
+ <i class="fas fa-search filter-icon"></i>
72
+ </div>
73
+ </div>
74
+ <nav class="navigation">
75
+
76
+ <div class="nav-section" data-level="0">
77
+ <a class="nav-title" href="/README.html" >
78
+ <i class="fas fa-home"></i> Documentation
79
+ </a>
80
+ <div class="nav-content" >
81
+ <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
82
+ <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>
83
+ <a href="/image-modal-test.html" class="nav-item" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="fas fa-file-alt"></i> Image Modal Test</a>
84
+ <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
85
+ <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
86
+ <div class="nav-section" data-level="1">
87
+ <a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
88
+ <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
89
+ </a>
90
+ <div class="nav-content collapsed" id="nav-guides-1">
91
+ <a href="/guides/authentication-default-change.html" class="nav-item" data-tooltip="Starting from version 1.7.4, @knowcode/doc-builder now defaults to no authentication for all documentation sites."><i class="fas fa-file-alt"></i> Authentication Default Change</a>
92
+ <a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase - a secure, scalable authentication platform."><i class="fas fa-file-alt"></i> Authentication Guide</a>
93
+ <a href="/guides/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>
94
+ <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>
95
+ <a href="/guides/image-modal-guide.html" class="nav-item" data-tooltip="When users click on any image in your generated documentation, it opens in a professional modal overlay with: Full-screen viewing experience Smooth..."><i class="fas fa-file-alt"></i> Image Modal Guide</a>
96
+ <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>
97
+ <a href="/guides/private-directory-authentication.html" class="nav-item" data-tooltip="The @knowcode/doc-builder provides flexible authentication options to protect your documentation."><i class="fas fa-file-alt"></i> Private Directory Authentication</a>
98
+ <a href="/guides/public-site-deployment.html" class="nav-item" data-tooltip="The @knowcode/doc-builder now supports deploying public documentation sites without authentication."><i class="fas fa-file-alt"></i> Public Site Deployment</a>
99
+ <a href="/guides/search-engine-verification-guide.html" class="nav-item" data-tooltip="Search engine verification provides access to powerful webmaster tools:."><i class="fas fa-file-alt"></i> Search Engine Verification Guide</a>
100
+ <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>
101
+ <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>
102
+ <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>
103
+ <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>
104
+ <div class="nav-section" data-level="1">
105
+ <a class="nav-title collapsible" href="#" data-target="nav-private-1" >
106
+ <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
107
+ </a>
108
+ <div class="nav-content collapsed" id="nav-private-1">
109
+ <a href="/private/cache-control-anti-pattern.html" class="nav-item" data-tooltip="Cache Control Anti-Pattern: Why Aggressive Cache-Busting is Bad for Documentation Sites."><i class="fas fa-file-alt"></i> Cache Control Anti Pattern</a>
110
+ <a href="/private/next-steps-walkthrough.html" class="nav-item" data-tooltip="Now that we&#039;ve implemented Supabase authentication, let&#039;s walk through testing the implementation and preparing for deployment."><i class="fas fa-file-alt"></i> Next Steps Walkthrough</a>
111
+ <a href="/private/supabase-auth-implementation-completed.html" class="nav-item" data-tooltip="This document records the successful implementation of Supabase authentication in @knowcode/doc-builder v1.7.5+."><i class="fas fa-file-alt"></i> Supabase Auth Implementation Completed</a>
112
+ <a href="/private/supabase-auth-implementation-plan.html" class="nav-item" data-tooltip="Supabase Auth Implementation Plan for @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Supabase Auth Implementation Plan</a>
113
+ <a href="/private/supabase-auth-integration-plan.html" class="nav-item" data-tooltip="Supabase Authentication Integration Plan for @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Supabase Auth Integration Plan</a>
114
+ <a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="fas fa-file-alt"></i> Supabase Auth Setup Guide</a>
115
+ <a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="fas fa-file-alt"></i> Test Private Doc</a>
116
+ <a href="/private/user-management-tooling.html" class="nav-item" data-tooltip="The user management system is a set of tools designed to manage user access to Supabase-authenticated documentation sites built with."><i class="fas fa-file-alt"></i> User Management Tooling</a></div></div>
117
+ <div class="nav-section" data-level="2">
118
+ <a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
119
+ <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
120
+ </a>
121
+ <div class="nav-content collapsed" id="nav-private-launch-2">
122
+ <a href="/private/launch/README.html" class="nav-item" data-tooltip="This directory contains all documentation related to the commercial launch of @knowcode/doc-builder, including go-to-market strategy, platform..."><i class="fas fa-file-alt"></i> Launch Overview</a>
123
+ <a href="/private/launch/auth-cleanup-summary.html" class="nav-item" data-tooltip="All references to the old client-side authentication system have been removed from @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Auth Cleanup Summary</a>
124
+ <a href="/private/launch/bubble-plugin-specification.html" class="nav-item" data-tooltip="This document outlines the technical specification for creating a Bubble.io plugin that integrates @knowcode/doc-builder, enabling Bubble developers..."><i class="fas fa-file-alt"></i> Bubble Plugin Specification</a>
125
+ <a href="/private/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy &amp; Product Launch Plan."><i class="fas fa-file-alt"></i> Go To Market Strategy</a>
126
+ <a href="/private/launch/launch-announcements.html" class="nav-item" data-tooltip="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels."><i class="fas fa-file-alt"></i> Launch Announcements</a>
127
+ <a href="/private/launch/vercel-deployment-auth-setup.html" class="nav-item" data-tooltip="Vercel Deployment Authentication Setup Guide."><i class="fas fa-file-alt"></i> Vercel Deployment Auth Setup</a></div></div>
128
+ <div class="nav-section" data-level="1">
129
+ <a class="nav-title collapsible expanded" href="#" data-target="nav-prompts-1" >
130
+ <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Prompts
131
+ </a>
132
+ <div class="nav-content" id="nav-prompts-1">
133
+ <a href="/prompts/markdown-document-standards.html" class="nav-item active" data-tooltip="Detailed introduction to the topic..."><i class="fas fa-file-alt"></i> Markdown Document Standards</a></div></div>
134
+ </nav>
135
+ <div class="resize-handle"></div>
136
+ </aside>
137
+
138
+ <!-- Content Area -->
139
+ <main class="content">
140
+ <div class="content-inner">
141
+ <h1>Markdown Document Standards Prompt</h1>
142
+ <p>Use this prompt when creating or updating documentation for doc-builder projects to ensure consistency and quality.</p>
143
+ <h2>Prompt</h2>
144
+ <p>Please follow these markdown documentation standards when creating or editing documents:</p>
145
+ <h3>1. Document Structure</h3>
146
+ <p><strong>Required Elements:</strong></p>
147
+ <ul>
148
+ <li>Start with a clear H1 title (<code># Document Title</code>)</li>
149
+ <li>Include a brief overview paragraph immediately after the title</li>
150
+ <li>Use hierarchical heading structure (H2 for main sections, H3 for subsections)</li>
151
+ <li>End with a summary or conclusion when appropriate</li>
152
+ </ul>
153
+ <p><strong>Example Structure:</strong></p>
154
+ <pre><code class="language-markdown"># Feature Guide Title
155
+
156
+ Brief overview explaining what this document covers and why it&#39;s important.
157
+
158
+ ## Overview
159
+ Detailed introduction to the topic...
160
+
161
+ ## Main Section
162
+ ### Subsection
163
+ Content...
164
+
165
+ ## Conclusion
166
+ Summary of key points...
167
+ </code></pre>
168
+ <h3>2. File Naming Conventions</h3>
169
+ <ul>
170
+ <li>Use lowercase with hyphens: <code>feature-name-guide.md</code></li>
171
+ <li>Be descriptive but concise: <code>authentication-setup.md</code> not <code>auth.md</code></li>
172
+ <li>Use standard suffixes:<ul>
173
+ <li><code>-guide.md</code> for how-to guides</li>
174
+ <li><code>-reference.md</code> for API/technical references</li>
175
+ <li><code>-overview.md</code> for conceptual explanations</li>
176
+ <li><code>-troubleshooting.md</code> for problem-solving docs</li>
177
+ </ul>
178
+ </li>
179
+ </ul>
180
+ <h3>3. Image Guidelines</h3>
181
+ <p><strong>When including images:</strong></p>
182
+ <ul>
183
+ <li>Always use meaningful alt text that describes the image content</li>
184
+ <li>Store images in an <code>images/</code> or <code>assets/</code> subdirectory</li>
185
+ <li>Use descriptive filenames: <code>authentication-flow-diagram.png</code> not <code>img1.png</code></li>
186
+ </ul>
187
+ <p><strong>Image Markdown Format:</strong></p>
188
+ <pre><code class="language-markdown">![Description of what the image shows](images/feature-screenshot.png)
189
+ </code></pre>
190
+ <p><strong>Good Alt Text Examples:</strong></p>
191
+ <ul>
192
+ <li>✅ <code>![Vercel deployment settings page showing environment variables section](images/vercel-env-setup.png)</code></li>
193
+ <li>✅ <code>![Flow diagram illustrating the authentication process from login to dashboard](images/auth-flow.png)</code></li>
194
+ <li>❌ <code>![Screenshot](img1.png)</code></li>
195
+ <li>❌ <code>![Image](screenshot.png)</code></li>
196
+ </ul>
197
+ <h3>4. Code Examples</h3>
198
+ <p><strong>Code Block Requirements:</strong></p>
199
+ <ul>
200
+ <li>Always specify the language for syntax highlighting</li>
201
+ <li>Include comments for complex code</li>
202
+ <li>Show both correct and incorrect usage when relevant</li>
203
+ <li>Keep examples concise and focused</li>
204
+ </ul>
205
+ <pre><code class="language-javascript">// Good example with language specified
206
+ const config = {
207
+ siteName: &#39;My Documentation&#39;,
208
+ features: {
209
+ authentication: true
210
+ }
211
+ };
212
+ </code></pre>
213
+ <h3>5. Special Folders and Files</h3>
214
+ <p><strong>Navigation Control:</strong></p>
215
+ <ul>
216
+ <li>Files/folders starting with <code>_</code> are excluded from navigation</li>
217
+ <li>Use for drafts: <code>_draft-feature.md</code></li>
218
+ <li>Use for internal notes: <code>_internal/planning.md</code></li>
219
+ </ul>
220
+ <p><strong>Special Files:</strong></p>
221
+ <ul>
222
+ <li><code>README.md</code> in any folder becomes the folder&#39;s overview page</li>
223
+ <li><code>index.md</code> takes priority over <code>README.md</code> for the main page</li>
224
+ </ul>
225
+ <h3>6. Content Guidelines</h3>
226
+ <p><strong>Writing Style:</strong></p>
227
+ <ul>
228
+ <li>Use clear, concise language</li>
229
+ <li>Write in active voice</li>
230
+ <li>Use present tense for instructions</li>
231
+ <li>Include examples whenever possible</li>
232
+ </ul>
233
+ <p><strong>Lists and Tables:</strong></p>
234
+ <ul>
235
+ <li>Use bullet points for unordered information</li>
236
+ <li>Use numbered lists for sequential steps</li>
237
+ <li>Include tables for comparing options or listing parameters</li>
238
+ </ul>
239
+ <p><strong>Links:</strong></p>
240
+ <ul>
241
+ <li>Use descriptive link text: <code>[See the authentication guide](auth-guide.md)</code></li>
242
+ <li>Never use &quot;click here&quot; or bare URLs</li>
243
+ <li>Prefer relative links for internal documentation</li>
244
+ </ul>
245
+ <h3>7. Front Matter (Optional)</h3>
246
+ <p>For SEO and page customization:</p>
247
+ <pre><code class="language-yaml">---
248
+ title: Custom Page Title
249
+ description: Brief description for SEO
250
+ keywords: authentication, setup, configuration
251
+ ---
252
+ </code></pre>
253
+ <h3>8. Accessibility</h3>
254
+ <ul>
255
+ <li>Use proper heading hierarchy (don&#39;t skip levels)</li>
256
+ <li>Include alt text for all images</li>
257
+ <li>Use descriptive link text</li>
258
+ <li>Ensure code examples are screen-reader friendly</li>
259
+ </ul>
260
+ <h3>9. Mermaid Diagrams</h3>
261
+ <p>When using Mermaid diagrams:</p>
262
+ <pre><code class="language-markdown"><div class="mermaid-wrapper">
263
+ <div class="mermaid-title">Diagram</div>
264
+ <div class="mermaid">graph TD
265
+ A[Start] --> B{Decision}
266
+ B -->|Yes| C[Process]
267
+ B -->|No| D[End]</div>
268
+ </div>
269
+
270
+ ### 10. Version References
271
+
272
+ When mentioning version-specific features:
273
+ - Always specify the version: &quot;Available in v1.8.5+&quot;
274
+ - Link to changelog when discussing changes
275
+ - Use semantic versioning consistently
276
+
277
+ Remember: These standards ensure documentation is consistent, accessible, and easy to maintain. When in doubt, prioritize clarity and user experience.
278
+ </code></pre>
279
+
280
+ </div>
281
+ </main>
282
+ </div>
283
+
284
+ <!-- Scripts -->
285
+ <script src="/js/main.js"></script>
286
+
287
+ </body>
288
+ </html>