@knowcode/doc-builder 1.8.7 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/settings.local.json +2 -1
- package/CHANGELOG.md +27 -0
- package/assets/css/notion-style.css +141 -0
- package/assets/js/main.js +76 -0
- package/html/README.html +10 -3
- package/html/css/notion-style.css +141 -0
- package/html/documentation-index.html +10 -3
- package/html/guides/authentication-default-change.html +10 -3
- package/html/guides/authentication-guide.html +10 -3
- package/html/guides/claude-workflow-guide.html +10 -3
- package/html/guides/documentation-standards.html +10 -3
- package/html/guides/phosphor-icons-guide.html +10 -3
- package/html/guides/private-directory-authentication.html +10 -3
- package/html/guides/public-site-deployment.html +10 -3
- package/html/guides/search-engine-verification-guide.html +10 -3
- package/html/guides/seo-guide.html +10 -3
- package/html/guides/seo-optimization-guide.html +10 -3
- package/html/guides/troubleshooting-guide.html +10 -3
- package/html/guides/windows-setup-guide.html +10 -3
- package/html/image-modal-test.html +305 -0
- package/html/index.html +10 -3
- package/html/js/main.js +76 -0
- package/html/private/cache-control-anti-pattern.html +10 -3
- package/html/private/launch/README.html +10 -3
- package/html/private/launch/auth-cleanup-summary.html +10 -3
- package/html/private/launch/bubble-plugin-specification.html +10 -3
- package/html/private/launch/go-to-market-strategy.html +10 -3
- package/html/private/launch/launch-announcements.html +10 -3
- package/html/private/launch/vercel-deployment-auth-setup.html +10 -3
- package/html/private/next-steps-walkthrough.html +11 -4
- package/html/private/supabase-auth-implementation-completed.html +10 -3
- package/html/private/supabase-auth-implementation-plan.html +10 -3
- package/html/private/supabase-auth-integration-plan.html +10 -3
- package/html/private/supabase-auth-setup-guide.html +10 -3
- package/html/private/test-private-doc.html +10 -3
- package/html/private/user-management-tooling.html +10 -3
- package/html/prompts/markdown-document-standards.html +409 -0
- package/html/sitemap.xml +56 -44
- package/html/vercel-cli-setup-guide.html +10 -3
- package/html/vercel-first-time-setup-guide.html +10 -3
- package/lib/core-builder.js +1 -0
- package/lib/emoji-mapper.js +13 -0
- package/package/assets/css/notion-style.css +432 -135
- package/package/assets/js/main.js +259 -25
- package/package.json +1 -1
|
@@ -0,0 +1,409 @@
|
|
|
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="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">
|
|
34
|
+
|
|
35
|
+
<!-- Fonts -->
|
|
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">
|
|
37
|
+
|
|
38
|
+
<!-- Icons -->
|
|
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">
|
|
41
|
+
|
|
42
|
+
<!-- Mermaid -->
|
|
43
|
+
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
44
|
+
|
|
45
|
+
<!-- Styles -->
|
|
46
|
+
<link rel="stylesheet" href="/css/notion-style.css">
|
|
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
|
+
|
|
83
|
+
<!-- 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": "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-27T08:30:10.837Z",
|
|
102
|
+
"dateModified": "2025-07-27T08:30:10.837Z",
|
|
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>
|
|
132
|
+
</head>
|
|
133
|
+
<body>
|
|
134
|
+
<!-- Header -->
|
|
135
|
+
<header class="header">
|
|
136
|
+
<div class="header-content">
|
|
137
|
+
<a href="/index.html" class="logo">@knowcode/doc-builder</a>
|
|
138
|
+
|
|
139
|
+
<div class="header-actions">
|
|
140
|
+
<div class="deployment-info">
|
|
141
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.0">Last updated: Jul 27, 2025, 08:30 AM UTC</span>
|
|
142
|
+
</div>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<a href="../../login.html" class="auth-btn" title="Login/Logout">
|
|
146
|
+
<i class="fas fa-sign-in-alt"></i>
|
|
147
|
+
</a>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
151
|
+
<i class="fas fa-moon"></i>
|
|
152
|
+
</button>
|
|
153
|
+
|
|
154
|
+
<button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
|
|
155
|
+
<i class="fas fa-bars"></i>
|
|
156
|
+
</button>
|
|
157
|
+
</div>
|
|
158
|
+
</div>
|
|
159
|
+
</header>
|
|
160
|
+
|
|
161
|
+
<!-- Preview Banner -->
|
|
162
|
+
<div id="preview-banner" class="preview-banner">
|
|
163
|
+
<div class="banner-content">
|
|
164
|
+
<i class="fas fa-exclamation-triangle banner-icon"></i>
|
|
165
|
+
<span class="banner-text">This documentation is a preview version - some content may be incomplete</span>
|
|
166
|
+
<button id="dismiss-banner" class="banner-dismiss" aria-label="Dismiss banner">
|
|
167
|
+
<i class="fas fa-times"></i>
|
|
168
|
+
</button>
|
|
169
|
+
</div>
|
|
170
|
+
</div>
|
|
171
|
+
|
|
172
|
+
<!-- Breadcrumbs -->
|
|
173
|
+
<nav class="breadcrumbs" id="breadcrumbs">
|
|
174
|
+
<!-- Breadcrumbs will be generated by JavaScript -->
|
|
175
|
+
</nav>
|
|
176
|
+
|
|
177
|
+
<!-- Main Content -->
|
|
178
|
+
<div class="main-wrapper">
|
|
179
|
+
<!-- Sidebar -->
|
|
180
|
+
<aside class="sidebar">
|
|
181
|
+
<div class="sidebar-header">
|
|
182
|
+
<div class="filter-box">
|
|
183
|
+
<input type="text" placeholder="Filter items..." class="filter-input" id="nav-filter">
|
|
184
|
+
<i class="fas fa-search filter-icon"></i>
|
|
185
|
+
</div>
|
|
186
|
+
</div>
|
|
187
|
+
<nav class="navigation">
|
|
188
|
+
|
|
189
|
+
<div class="nav-section" data-level="0">
|
|
190
|
+
<a class="nav-title" href="/README.html" >
|
|
191
|
+
<i class="fas fa-home"></i> Documentation
|
|
192
|
+
</a>
|
|
193
|
+
<div class="nav-content" >
|
|
194
|
+
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
195
|
+
<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>
|
|
196
|
+
<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>
|
|
197
|
+
<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>
|
|
198
|
+
<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>
|
|
199
|
+
<div class="nav-section" data-level="1">
|
|
200
|
+
<a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
|
|
201
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
202
|
+
</a>
|
|
203
|
+
<div class="nav-content collapsed" id="nav-guides-1">
|
|
204
|
+
<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>
|
|
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>
|
|
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>
|
|
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/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>
|
|
209
|
+
<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>
|
|
210
|
+
<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>
|
|
211
|
+
<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>
|
|
212
|
+
<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>
|
|
213
|
+
<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>
|
|
214
|
+
<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>
|
|
215
|
+
<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>
|
|
216
|
+
<div class="nav-section private-nav" data-level="1">
|
|
217
|
+
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
218
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
219
|
+
</a>
|
|
220
|
+
<div class="nav-content collapsed" id="nav-private-1">
|
|
221
|
+
<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>
|
|
222
|
+
<a href="/private/next-steps-walkthrough.html" class="nav-item" data-tooltip="Now that we've implemented Supabase authentication, let's walk through testing the implementation and preparing for deployment."><i class="fas fa-file-alt"></i> Next Steps Walkthrough</a>
|
|
223
|
+
<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>
|
|
224
|
+
<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>
|
|
225
|
+
<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>
|
|
226
|
+
<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>
|
|
227
|
+
<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>
|
|
228
|
+
<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>
|
|
229
|
+
<div class="nav-section private-nav" data-level="2">
|
|
230
|
+
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
231
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
232
|
+
</a>
|
|
233
|
+
<div class="nav-content collapsed" id="nav-private-launch-2">
|
|
234
|
+
<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>
|
|
235
|
+
<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>
|
|
236
|
+
<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>
|
|
237
|
+
<a href="/private/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy & Product Launch Plan."><i class="fas fa-file-alt"></i> Go To Market Strategy</a>
|
|
238
|
+
<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>
|
|
239
|
+
<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>
|
|
240
|
+
<div class="nav-section" data-level="1">
|
|
241
|
+
<a class="nav-title collapsible expanded" href="#" data-target="nav-prompts-1" >
|
|
242
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Prompts
|
|
243
|
+
</a>
|
|
244
|
+
<div class="nav-content" id="nav-prompts-1">
|
|
245
|
+
<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>
|
|
246
|
+
</nav>
|
|
247
|
+
<div class="resize-handle"></div>
|
|
248
|
+
</aside>
|
|
249
|
+
|
|
250
|
+
<!-- Content Area -->
|
|
251
|
+
<main class="content">
|
|
252
|
+
<div class="content-inner">
|
|
253
|
+
<h1>Markdown Document Standards Prompt</h1>
|
|
254
|
+
<p>Use this prompt when creating or updating documentation for doc-builder projects to ensure consistency and quality.</p>
|
|
255
|
+
<h2>Prompt</h2>
|
|
256
|
+
<p>Please follow these markdown documentation standards when creating or editing documents:</p>
|
|
257
|
+
<h3>1. Document Structure</h3>
|
|
258
|
+
<p><strong>Required Elements:</strong></p>
|
|
259
|
+
<ul>
|
|
260
|
+
<li>Start with a clear H1 title (<code># Document Title</code>)</li>
|
|
261
|
+
<li>Include a brief overview paragraph immediately after the title</li>
|
|
262
|
+
<li>Use hierarchical heading structure (H2 for main sections, H3 for subsections)</li>
|
|
263
|
+
<li>End with a summary or conclusion when appropriate</li>
|
|
264
|
+
</ul>
|
|
265
|
+
<p><strong>Example Structure:</strong></p>
|
|
266
|
+
<pre><code class="language-markdown"># Feature Guide Title
|
|
267
|
+
|
|
268
|
+
Brief overview explaining what this document covers and why it's important.
|
|
269
|
+
|
|
270
|
+
## Overview
|
|
271
|
+
Detailed introduction to the topic...
|
|
272
|
+
|
|
273
|
+
## Main Section
|
|
274
|
+
### Subsection
|
|
275
|
+
Content...
|
|
276
|
+
|
|
277
|
+
## Conclusion
|
|
278
|
+
Summary of key points...
|
|
279
|
+
</code></pre>
|
|
280
|
+
<h3>2. File Naming Conventions</h3>
|
|
281
|
+
<ul>
|
|
282
|
+
<li>Use lowercase with hyphens: <code>feature-name-guide.md</code></li>
|
|
283
|
+
<li>Be descriptive but concise: <code>authentication-setup.md</code> not <code>auth.md</code></li>
|
|
284
|
+
<li>Use standard suffixes:<ul>
|
|
285
|
+
<li><code>-guide.md</code> for how-to guides</li>
|
|
286
|
+
<li><code>-reference.md</code> for API/technical references</li>
|
|
287
|
+
<li><code>-overview.md</code> for conceptual explanations</li>
|
|
288
|
+
<li><code>-troubleshooting.md</code> for problem-solving docs</li>
|
|
289
|
+
</ul>
|
|
290
|
+
</li>
|
|
291
|
+
</ul>
|
|
292
|
+
<h3>3. Image Guidelines</h3>
|
|
293
|
+
<p><strong>When including images:</strong></p>
|
|
294
|
+
<ul>
|
|
295
|
+
<li>Always use meaningful alt text that describes the image content</li>
|
|
296
|
+
<li>Store images in an <code>images/</code> or <code>assets/</code> subdirectory</li>
|
|
297
|
+
<li>Use descriptive filenames: <code>authentication-flow-diagram.png</code> not <code>img1.png</code></li>
|
|
298
|
+
</ul>
|
|
299
|
+
<p><strong>Image Markdown Format:</strong></p>
|
|
300
|
+
<pre><code class="language-markdown">
|
|
301
|
+
</code></pre>
|
|
302
|
+
<p><strong>Good Alt Text Examples:</strong></p>
|
|
303
|
+
<ul>
|
|
304
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <code></code></li>
|
|
305
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <code></code></li>
|
|
306
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> <code></code></li>
|
|
307
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> <code></code></li>
|
|
308
|
+
</ul>
|
|
309
|
+
<h3>4. Code Examples</h3>
|
|
310
|
+
<p><strong>Code Block Requirements:</strong></p>
|
|
311
|
+
<ul>
|
|
312
|
+
<li>Always specify the language for syntax highlighting</li>
|
|
313
|
+
<li>Include comments for complex code</li>
|
|
314
|
+
<li>Show both correct and incorrect usage when relevant</li>
|
|
315
|
+
<li>Keep examples concise and focused</li>
|
|
316
|
+
</ul>
|
|
317
|
+
<pre><code class="language-javascript">// Good example with language specified
|
|
318
|
+
const config = {
|
|
319
|
+
siteName: 'My Documentation',
|
|
320
|
+
features: {
|
|
321
|
+
authentication: true
|
|
322
|
+
}
|
|
323
|
+
};
|
|
324
|
+
</code></pre>
|
|
325
|
+
<h3>5. Special Folders and Files</h3>
|
|
326
|
+
<p><strong>Navigation Control:</strong></p>
|
|
327
|
+
<ul>
|
|
328
|
+
<li>Files/folders starting with <code>_</code> are excluded from navigation</li>
|
|
329
|
+
<li>Use for drafts: <code>_draft-feature.md</code></li>
|
|
330
|
+
<li>Use for internal notes: <code>_internal/planning.md</code></li>
|
|
331
|
+
</ul>
|
|
332
|
+
<p><strong>Special Files:</strong></p>
|
|
333
|
+
<ul>
|
|
334
|
+
<li><code>README.md</code> in any folder becomes the folder's overview page</li>
|
|
335
|
+
<li><code>index.md</code> takes priority over <code>README.md</code> for the main page</li>
|
|
336
|
+
</ul>
|
|
337
|
+
<h3>6. Content Guidelines</h3>
|
|
338
|
+
<p><strong>Writing Style:</strong></p>
|
|
339
|
+
<ul>
|
|
340
|
+
<li>Use clear, concise language</li>
|
|
341
|
+
<li>Write in active voice</li>
|
|
342
|
+
<li>Use present tense for instructions</li>
|
|
343
|
+
<li>Include examples whenever possible</li>
|
|
344
|
+
</ul>
|
|
345
|
+
<p><strong>Lists and Tables:</strong></p>
|
|
346
|
+
<ul>
|
|
347
|
+
<li>Use bullet points for unordered information</li>
|
|
348
|
+
<li>Use numbered lists for sequential steps</li>
|
|
349
|
+
<li>Include tables for comparing options or listing parameters</li>
|
|
350
|
+
</ul>
|
|
351
|
+
<p><strong>Links:</strong></p>
|
|
352
|
+
<ul>
|
|
353
|
+
<li>Use descriptive link text: <code>[See the authentication guide](auth-guide.md)</code></li>
|
|
354
|
+
<li>Never use "click here" or bare URLs</li>
|
|
355
|
+
<li>Prefer relative links for internal documentation</li>
|
|
356
|
+
</ul>
|
|
357
|
+
<h3>7. Front Matter (Optional)</h3>
|
|
358
|
+
<p>For SEO and page customization:</p>
|
|
359
|
+
<pre><code class="language-yaml">---
|
|
360
|
+
title: Custom Page Title
|
|
361
|
+
description: Brief description for SEO
|
|
362
|
+
keywords: authentication, setup, configuration
|
|
363
|
+
---
|
|
364
|
+
</code></pre>
|
|
365
|
+
<h3>8. Accessibility</h3>
|
|
366
|
+
<ul>
|
|
367
|
+
<li>Use proper heading hierarchy (don't skip levels)</li>
|
|
368
|
+
<li>Include alt text for all images</li>
|
|
369
|
+
<li>Use descriptive link text</li>
|
|
370
|
+
<li>Ensure code examples are screen-reader friendly</li>
|
|
371
|
+
</ul>
|
|
372
|
+
<h3>9. Mermaid Diagrams</h3>
|
|
373
|
+
<p>When using Mermaid diagrams:</p>
|
|
374
|
+
<pre><code class="language-markdown"><div class="mermaid-wrapper">
|
|
375
|
+
<div class="mermaid">graph TD
|
|
376
|
+
A[Start] --> B{Decision}
|
|
377
|
+
B -->|Yes| C[Process]
|
|
378
|
+
B -->|No| D[End]</div>
|
|
379
|
+
</div>
|
|
380
|
+
|
|
381
|
+
### 10. Version References
|
|
382
|
+
|
|
383
|
+
When mentioning version-specific features:
|
|
384
|
+
- Always specify the version: "Available in v1.8.5+"
|
|
385
|
+
- Link to changelog when discussing changes
|
|
386
|
+
- Use semantic versioning consistently
|
|
387
|
+
|
|
388
|
+
Remember: These standards ensure documentation is consistent, accessible, and easy to maintain. When in doubt, prioritize clarity and user experience.
|
|
389
|
+
</code></pre>
|
|
390
|
+
|
|
391
|
+
</div>
|
|
392
|
+
</main>
|
|
393
|
+
</div>
|
|
394
|
+
|
|
395
|
+
<!-- Scripts -->
|
|
396
|
+
<script>
|
|
397
|
+
// Pass configuration to frontend
|
|
398
|
+
window.docBuilderConfig = {
|
|
399
|
+
features: {
|
|
400
|
+
showPdfDownload: true,
|
|
401
|
+
menuDefaultOpen: false
|
|
402
|
+
}
|
|
403
|
+
};
|
|
404
|
+
</script>
|
|
405
|
+
<script src="/js/main.js"></script>
|
|
406
|
+
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
407
|
+
<script src="/js/auth.js"></script>
|
|
408
|
+
</body>
|
|
409
|
+
</html>
|