@knowcode/doc-builder 1.9.1 → 1.9.2
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 +29 -0
- package/README.md +1 -0
- package/html/README.html +150 -33
- package/html/css/notion-style.css +394 -13
- package/html/documentation-index.html +128 -10
- package/html/guides/authentication-default-change.html +131 -7
- package/html/guides/authentication-guide.html +142 -19
- package/html/guides/claude-workflow-guide.html +138 -22
- package/html/guides/documentation-standards.html +134 -11
- package/html/guides/html-embedding-guide.html +450 -0
- package/html/guides/image-modal-guide.html +133 -10
- package/html/guides/phosphor-icons-guide.html +151 -27
- package/html/guides/private-directory-authentication.html +131 -7
- package/html/guides/public-site-deployment.html +131 -7
- package/html/guides/search-engine-verification-guide.html +131 -7
- package/html/guides/seo-guide.html +131 -7
- package/html/guides/seo-optimization-guide.html +160 -38
- package/html/guides/troubleshooting-guide.html +142 -19
- package/html/guides/windows-setup-guide.html +162 -38
- package/html/image-modal-test.html +126 -8
- package/html/index.html +150 -33
- package/html/js/auth.js +118 -39
- package/html/js/main.js +259 -25
- package/html/private/cache-control-anti-pattern.html +136 -12
- package/html/private/launch/README.html +145 -15
- package/html/private/launch/auth-cleanup-summary.html +154 -24
- package/html/private/launch/bubble-plugin-specification.html +137 -7
- package/html/private/launch/go-to-market-strategy.html +139 -9
- package/html/private/launch/launch-announcements.html +153 -24
- package/html/private/launch/vercel-deployment-auth-setup.html +139 -9
- package/html/private/next-steps-walkthrough.html +138 -14
- package/html/private/supabase-auth-implementation-completed.html +144 -21
- package/html/private/supabase-auth-implementation-plan.html +137 -14
- package/html/private/supabase-auth-integration-plan.html +143 -21
- package/html/private/supabase-auth-setup-guide.html +140 -16
- package/html/private/test-private-doc.html +131 -7
- package/html/private/user-management-tooling.html +131 -7
- package/html/prompts/markdown-document-standards.html +135 -12
- package/html/sitemap.xml +58 -46
- package/html/vercel-cli-setup-guide.html +129 -11
- package/html/vercel-first-time-setup-guide.html +126 -8
- package/lib/config.js +2 -0
- package/package.json +1 -1
|
@@ -3,14 +3,41 @@
|
|
|
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>Test Private Document
|
|
6
|
+
<meta name="description" content="This is a test document in the private directory. It should only be visible to authenticated users.">
|
|
7
|
+
<title>Test Private Document | @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, private, should">
|
|
11
|
+
<meta name="robots" content="index, follow">
|
|
12
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/private/test-private-doc.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/test-private-doc.html">
|
|
17
|
+
<meta property="og:title" content="Test Private Document | @knowcode/doc-builder">
|
|
18
|
+
<meta property="og:description" content="This is a test document in the private directory. It should only be visible to authenticated users.">
|
|
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="Test Private Document | @knowcode/doc-builder">
|
|
28
|
+
<meta name="twitter:description" content="This is a test document in the private directory. It should only be visible to authenticated users.">
|
|
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">
|
|
8
34
|
|
|
9
35
|
<!-- Fonts -->
|
|
10
36
|
<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
37
|
|
|
12
38
|
<!-- Icons -->
|
|
13
39
|
<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">
|
|
14
41
|
|
|
15
42
|
<!-- Mermaid -->
|
|
16
43
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -18,8 +45,90 @@
|
|
|
18
45
|
<!-- Styles -->
|
|
19
46
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
20
47
|
|
|
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
|
+
|
|
21
83
|
<!-- 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
|
|
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": "Test Private Document",
|
|
91
|
+
"description": "This is a test document in the private directory. It should only be visible to authenticated users.",
|
|
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-28T10:31:53.257Z",
|
|
102
|
+
"dateModified": "2025-07-28T10:31:53.257Z",
|
|
103
|
+
"mainEntityOfPage": {
|
|
104
|
+
"@type": "WebPage",
|
|
105
|
+
"@id": "https://doc-builder-delta.vercel.app/private/test-private-doc.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": "Test Private Doc",
|
|
126
|
+
"item": "https://doc-builder-delta.vercel.app/private/test-private-doc.html"
|
|
127
|
+
}
|
|
128
|
+
]
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
</script>
|
|
23
132
|
</head>
|
|
24
133
|
<body>
|
|
25
134
|
<!-- Header -->
|
|
@@ -29,10 +138,14 @@
|
|
|
29
138
|
|
|
30
139
|
<div class="header-actions">
|
|
31
140
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
141
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.1">Last updated: Jul 28, 2025, 10:31 AM UTC</span>
|
|
33
142
|
</div>
|
|
34
143
|
|
|
35
144
|
|
|
145
|
+
<a href="../../login.html" class="auth-btn" title="Login/Logout">
|
|
146
|
+
<i class="fas fa-sign-in-alt"></i>
|
|
147
|
+
</a>
|
|
148
|
+
|
|
36
149
|
|
|
37
150
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
38
151
|
<i class="fas fa-moon"></i>
|
|
@@ -92,6 +205,7 @@
|
|
|
92
205
|
<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
206
|
<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
207
|
<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>
|
|
208
|
+
<a href="/guides/html-embedding-guide.html" class="nav-item" data-tooltip="Starting from version 1.9.2, doc-builder treats HTML files ( and ) as attachments that are automatically copied to your output directory during the..."><i class="fas fa-file-alt"></i> Html Embedding Guide</a>
|
|
95
209
|
<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
210
|
<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
211
|
<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>
|
|
@@ -101,7 +215,7 @@
|
|
|
101
215
|
<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
216
|
<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
217
|
<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">
|
|
218
|
+
<div class="nav-section private-nav" data-level="1">
|
|
105
219
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-private-1" >
|
|
106
220
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
107
221
|
</a>
|
|
@@ -114,7 +228,7 @@
|
|
|
114
228
|
<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
229
|
<a href="/private/test-private-doc.html" class="nav-item active" data-tooltip="Test Private Document."><i class="fas fa-file-alt"></i> Test Private Doc</a>
|
|
116
230
|
<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">
|
|
231
|
+
<div class="nav-section private-nav" data-level="2">
|
|
118
232
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
119
233
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
120
234
|
</a>
|
|
@@ -161,7 +275,17 @@ SECRET_TOKEN=super-secret-value
|
|
|
161
275
|
</div>
|
|
162
276
|
|
|
163
277
|
<!-- Scripts -->
|
|
278
|
+
<script>
|
|
279
|
+
// Pass configuration to frontend
|
|
280
|
+
window.docBuilderConfig = {
|
|
281
|
+
features: {
|
|
282
|
+
showPdfDownload: true,
|
|
283
|
+
menuDefaultOpen: false
|
|
284
|
+
}
|
|
285
|
+
};
|
|
286
|
+
</script>
|
|
164
287
|
<script src="/js/main.js"></script>
|
|
165
|
-
|
|
288
|
+
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
289
|
+
<script src="/js/auth.js"></script>
|
|
166
290
|
</body>
|
|
167
291
|
</html>
|
|
@@ -3,14 +3,41 @@
|
|
|
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>User Management Tooling
|
|
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">
|
|
8
34
|
|
|
9
35
|
<!-- Fonts -->
|
|
10
36
|
<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
37
|
|
|
12
38
|
<!-- Icons -->
|
|
13
39
|
<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">
|
|
14
41
|
|
|
15
42
|
<!-- Mermaid -->
|
|
16
43
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -18,8 +45,90 @@
|
|
|
18
45
|
<!-- Styles -->
|
|
19
46
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
20
47
|
|
|
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
|
+
|
|
21
83
|
<!-- 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
|
|
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-28T10:31:53.259Z",
|
|
102
|
+
"dateModified": "2025-07-28T10:31:53.259Z",
|
|
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>
|
|
23
132
|
</head>
|
|
24
133
|
<body>
|
|
25
134
|
<!-- Header -->
|
|
@@ -29,10 +138,14 @@
|
|
|
29
138
|
|
|
30
139
|
<div class="header-actions">
|
|
31
140
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
141
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.1">Last updated: Jul 28, 2025, 10:31 AM UTC</span>
|
|
33
142
|
</div>
|
|
34
143
|
|
|
35
144
|
|
|
145
|
+
<a href="../../login.html" class="auth-btn" title="Login/Logout">
|
|
146
|
+
<i class="fas fa-sign-in-alt"></i>
|
|
147
|
+
</a>
|
|
148
|
+
|
|
36
149
|
|
|
37
150
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
38
151
|
<i class="fas fa-moon"></i>
|
|
@@ -92,6 +205,7 @@
|
|
|
92
205
|
<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
206
|
<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
207
|
<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>
|
|
208
|
+
<a href="/guides/html-embedding-guide.html" class="nav-item" data-tooltip="Starting from version 1.9.2, doc-builder treats HTML files ( and ) as attachments that are automatically copied to your output directory during the..."><i class="fas fa-file-alt"></i> Html Embedding Guide</a>
|
|
95
209
|
<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
210
|
<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
211
|
<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>
|
|
@@ -101,7 +215,7 @@
|
|
|
101
215
|
<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
216
|
<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
217
|
<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">
|
|
218
|
+
<div class="nav-section private-nav" data-level="1">
|
|
105
219
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-private-1" >
|
|
106
220
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
107
221
|
</a>
|
|
@@ -114,7 +228,7 @@
|
|
|
114
228
|
<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
229
|
<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
230
|
<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>
|
|
117
|
-
<div class="nav-section" data-level="2">
|
|
231
|
+
<div class="nav-section private-nav" data-level="2">
|
|
118
232
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
119
233
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
120
234
|
</a>
|
|
@@ -460,7 +574,17 @@ DATABASE_URL=postgresql://postgres:[password]@db.[project-id].supabase.co:5432/p
|
|
|
460
574
|
</div>
|
|
461
575
|
|
|
462
576
|
<!-- Scripts -->
|
|
577
|
+
<script>
|
|
578
|
+
// Pass configuration to frontend
|
|
579
|
+
window.docBuilderConfig = {
|
|
580
|
+
features: {
|
|
581
|
+
showPdfDownload: true,
|
|
582
|
+
menuDefaultOpen: false
|
|
583
|
+
}
|
|
584
|
+
};
|
|
585
|
+
</script>
|
|
463
586
|
<script src="/js/main.js"></script>
|
|
464
|
-
|
|
587
|
+
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
588
|
+
<script src="/js/auth.js"></script>
|
|
465
589
|
</body>
|
|
466
590
|
</html>
|
|
@@ -3,14 +3,41 @@
|
|
|
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>Markdown Document Standards Prompt
|
|
6
|
+
<meta name="description" content="Use this prompt when creating or updating documentation for doc-builder projects to ensure consistency and quality.">
|
|
7
|
+
<title>Markdown Document Standards Prompt | @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, use, when">
|
|
11
|
+
<meta name="robots" content="index, follow">
|
|
12
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/prompts/markdown-document-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/prompts/markdown-document-standards.html">
|
|
17
|
+
<meta property="og:title" content="Markdown Document Standards Prompt | @knowcode/doc-builder">
|
|
18
|
+
<meta property="og:description" content="Use this prompt when creating or updating documentation for doc-builder projects to ensure consistency and quality.">
|
|
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="Markdown Document Standards Prompt | @knowcode/doc-builder">
|
|
28
|
+
<meta name="twitter:description" content="Use this prompt when creating or updating documentation for doc-builder projects to ensure consistency and quality.">
|
|
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">
|
|
8
34
|
|
|
9
35
|
<!-- Fonts -->
|
|
10
36
|
<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
37
|
|
|
12
38
|
<!-- Icons -->
|
|
13
39
|
<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">
|
|
14
41
|
|
|
15
42
|
<!-- Mermaid -->
|
|
16
43
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -18,8 +45,90 @@
|
|
|
18
45
|
<!-- Styles -->
|
|
19
46
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
20
47
|
|
|
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
|
+
|
|
21
83
|
<!-- 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
|
|
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": "Markdown Document Standards Prompt",
|
|
91
|
+
"description": "Use this prompt when creating or updating documentation for doc-builder projects to ensure consistency and quality.",
|
|
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-28T10:31:53.261Z",
|
|
102
|
+
"dateModified": "2025-07-28T10:31:53.261Z",
|
|
103
|
+
"mainEntityOfPage": {
|
|
104
|
+
"@type": "WebPage",
|
|
105
|
+
"@id": "https://doc-builder-delta.vercel.app/prompts/markdown-document-standards.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": "Prompts",
|
|
120
|
+
"item": "https://doc-builder-delta.vercel.app/prompts/"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"@type": "ListItem",
|
|
124
|
+
"position": 3,
|
|
125
|
+
"name": "Markdown Document Standards",
|
|
126
|
+
"item": "https://doc-builder-delta.vercel.app/prompts/markdown-document-standards.html"
|
|
127
|
+
}
|
|
128
|
+
]
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
</script>
|
|
23
132
|
</head>
|
|
24
133
|
<body>
|
|
25
134
|
<!-- Header -->
|
|
@@ -29,10 +138,14 @@
|
|
|
29
138
|
|
|
30
139
|
<div class="header-actions">
|
|
31
140
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
141
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.1">Last updated: Jul 28, 2025, 10:31 AM UTC</span>
|
|
33
142
|
</div>
|
|
34
143
|
|
|
35
144
|
|
|
145
|
+
<a href="../../login.html" class="auth-btn" title="Login/Logout">
|
|
146
|
+
<i class="fas fa-sign-in-alt"></i>
|
|
147
|
+
</a>
|
|
148
|
+
|
|
36
149
|
|
|
37
150
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
38
151
|
<i class="fas fa-moon"></i>
|
|
@@ -92,6 +205,7 @@
|
|
|
92
205
|
<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
206
|
<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
207
|
<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>
|
|
208
|
+
<a href="/guides/html-embedding-guide.html" class="nav-item" data-tooltip="Starting from version 1.9.2, doc-builder treats HTML files ( and ) as attachments that are automatically copied to your output directory during the..."><i class="fas fa-file-alt"></i> Html Embedding Guide</a>
|
|
95
209
|
<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
210
|
<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
211
|
<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>
|
|
@@ -101,7 +215,7 @@
|
|
|
101
215
|
<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
216
|
<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
217
|
<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">
|
|
218
|
+
<div class="nav-section private-nav" data-level="1">
|
|
105
219
|
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
106
220
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
107
221
|
</a>
|
|
@@ -114,7 +228,7 @@
|
|
|
114
228
|
<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
229
|
<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
230
|
<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">
|
|
231
|
+
<div class="nav-section private-nav" data-level="2">
|
|
118
232
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
119
233
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
120
234
|
</a>
|
|
@@ -189,10 +303,10 @@ Summary of key points...
|
|
|
189
303
|
</code></pre>
|
|
190
304
|
<p><strong>Good Alt Text Examples:</strong></p>
|
|
191
305
|
<ul>
|
|
192
|
-
<li
|
|
193
|
-
<li
|
|
194
|
-
<li
|
|
195
|
-
<li
|
|
306
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <code></code></li>
|
|
307
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <code></code></li>
|
|
308
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> <code></code></li>
|
|
309
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> <code></code></li>
|
|
196
310
|
</ul>
|
|
197
311
|
<h3>4. Code Examples</h3>
|
|
198
312
|
<p><strong>Code Block Requirements:</strong></p>
|
|
@@ -260,7 +374,6 @@ keywords: authentication, setup, configuration
|
|
|
260
374
|
<h3>9. Mermaid Diagrams</h3>
|
|
261
375
|
<p>When using Mermaid diagrams:</p>
|
|
262
376
|
<pre><code class="language-markdown"><div class="mermaid-wrapper">
|
|
263
|
-
<div class="mermaid-title">Diagram</div>
|
|
264
377
|
<div class="mermaid">graph TD
|
|
265
378
|
A[Start] --> B{Decision}
|
|
266
379
|
B -->|Yes| C[Process]
|
|
@@ -282,7 +395,17 @@ Remember: These standards ensure documentation is consistent, accessible, and ea
|
|
|
282
395
|
</div>
|
|
283
396
|
|
|
284
397
|
<!-- Scripts -->
|
|
398
|
+
<script>
|
|
399
|
+
// Pass configuration to frontend
|
|
400
|
+
window.docBuilderConfig = {
|
|
401
|
+
features: {
|
|
402
|
+
showPdfDownload: true,
|
|
403
|
+
menuDefaultOpen: false
|
|
404
|
+
}
|
|
405
|
+
};
|
|
406
|
+
</script>
|
|
285
407
|
<script src="/js/main.js"></script>
|
|
286
|
-
|
|
408
|
+
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
409
|
+
<script src="/js/auth.js"></script>
|
|
287
410
|
</body>
|
|
288
411
|
</html>
|