@knowcode/doc-builder 1.9.20 → 1.9.21
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/cli.js +15 -1
- package/doc-builder.config.js +4 -2
- package/doc-builder.config.js.backup.1754567425847 +124 -0
- package/html/README.html +3 -3
- package/html/about-doc-builder.html +3 -3
- package/html/documentation-index.html +3 -3
- package/html/guides/authentication-default-change.html +3 -3
- package/html/guides/authentication-guide.html +3 -3
- package/html/guides/claude-workflow-guide.html +3 -3
- package/html/guides/configuration-guide.html +3 -3
- package/html/guides/documentation-standards.html +3 -3
- package/html/guides/html-embedding-guide.html +3 -3
- package/html/guides/image-modal-guide.html +3 -3
- package/html/guides/phosphor-icons-guide.html +3 -3
- package/html/guides/private-directory-authentication-troubleshooting.html +3 -3
- package/html/guides/private-directory-authentication.html +3 -3
- package/html/guides/public-site-deployment.html +3 -3
- package/html/guides/search-engine-verification-guide.html +3 -3
- package/html/guides/seo-guide.html +3 -3
- package/html/guides/seo-optimization-guide.html +3 -3
- package/html/guides/supabase-authentication-complete-guide.html +3 -3
- package/html/guides/troubleshooting-guide.html +3 -3
- package/html/guides/windows-setup-guide.html +3 -3
- package/html/image-modal-test.html +3 -3
- package/html/index.html +3 -3
- package/html/private/cache-control-anti-pattern.html +3 -3
- package/html/private/launch/README.html +3 -3
- package/html/private/launch/auth-cleanup-summary.html +3 -3
- package/html/private/launch/bubble-plugin-specification.html +3 -3
- package/html/private/launch/go-to-market-strategy.html +3 -3
- package/html/private/launch/launch-announcements.html +3 -3
- package/html/private/launch/vercel-deployment-auth-setup.html +3 -3
- package/html/private/next-steps-walkthrough.html +3 -3
- package/html/private/supabase-auth-implementation-completed.html +3 -3
- package/html/private/supabase-auth-implementation-plan.html +3 -3
- package/html/private/supabase-auth-integration-plan.html +3 -3
- package/html/private/supabase-auth-setup-guide.html +3 -3
- package/html/private/test-private-doc.html +3 -3
- package/html/private/user-management-tooling.html +3 -3
- package/html/prompts/beautiful-documentation-design.html +3 -3
- package/html/prompts/markdown-document-standards.html +3 -3
- package/html/prompts/project-rename-strategy-sasha-publish.html +3 -3
- package/html/sitemap.xml +59 -59
- package/html/test-questions/how-does-it-work%3F.html +3 -3
- package/html/test-questions/step-1%3A%20getting-started.html +3 -3
- package/html/test-questions/what-is-the-purpose.html +3 -3
- package/html/vercel-cli-setup-guide.html +3 -3
- package/html/vercel-first-time-setup-guide.html +3 -3
- package/html-static/404.html +115 -0
- package/html-static/README.html +456 -0
- package/html-static/about-doc-builder.html +425 -0
- package/html-static/css/notion-style.css +2426 -0
- package/html-static/documentation-index.html +405 -0
- package/html-static/guides/authentication-default-change.html +304 -0
- package/html-static/guides/authentication-guide.html +443 -0
- package/html-static/guides/claude-workflow-guide.html +1008 -0
- package/html-static/guides/configuration-guide.html +406 -0
- package/html-static/guides/documentation-standards.html +628 -0
- package/html-static/guides/html-embedding-guide.html +395 -0
- package/html-static/guides/image-modal-guide.html +449 -0
- package/html-static/guides/phosphor-icons-guide.html +518 -0
- package/html-static/guides/private-directory-authentication-troubleshooting.html +489 -0
- package/html-static/guides/private-directory-authentication.html +475 -0
- package/html-static/guides/public-site-deployment.html +365 -0
- package/html-static/guides/search-engine-verification-guide.html +476 -0
- package/html-static/guides/seo-guide.html +595 -0
- package/html-static/guides/seo-optimization-guide.html +821 -0
- package/html-static/guides/supabase-authentication-complete-guide.html +800 -0
- package/html-static/guides/troubleshooting-guide.html +567 -0
- package/html-static/guides/windows-setup-guide.html +793 -0
- package/html-static/image-modal-test.html +252 -0
- package/html-static/index.html +456 -0
- package/html-static/js/main.js +1692 -0
- package/html-static/prompts/beautiful-documentation-design.html +718 -0
- package/html-static/prompts/markdown-document-standards.html +356 -0
- package/html-static/prompts/project-rename-strategy-sasha-publish.html +464 -0
- package/html-static/robots.txt +5 -0
- package/html-static/sitemap.xml +189 -0
- package/html-static/test-questions/how-does-it-work%3F.html +228 -0
- package/html-static/test-questions/step-1%3A%20getting-started.html +223 -0
- package/html-static/test-questions/what-is-the-purpose.html +227 -0
- package/html-static/vercel-cli-setup-guide.html +429 -0
- package/html-static/vercel-first-time-setup-guide.html +388 -0
- package/lib/config.js +9 -2
- package/lib/core-builder.js +148 -4
- package/package.json +1 -1
|
@@ -0,0 +1,356 @@
|
|
|
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="generator" content="@knowcode/doc-builder by Knowcode Ltd">
|
|
10
|
+
<meta name="author" content="Lindsay Smith">
|
|
11
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, use, when">
|
|
12
|
+
<meta name="robots" content="index, follow">
|
|
13
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/prompts/markdown-document-standards.html">
|
|
14
|
+
|
|
15
|
+
<!-- Open Graph / Facebook -->
|
|
16
|
+
<meta property="og:type" content="article">
|
|
17
|
+
<meta property="og:url" content="https://doc-builder-delta.vercel.app/prompts/markdown-document-standards.html">
|
|
18
|
+
<meta property="og:title" content="Markdown Document Standards Prompt | @knowcode/doc-builder">
|
|
19
|
+
<meta property="og:description" content="Use this prompt when creating or updating documentation for doc-builder projects to ensure consistency and quality.">
|
|
20
|
+
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
21
|
+
<meta property="og:site_name" content="@knowcode/doc-builder">
|
|
22
|
+
<meta property="og:locale" content="en_US">
|
|
23
|
+
|
|
24
|
+
<!-- Twitter Card -->
|
|
25
|
+
<meta name="twitter:card" content="summary_large_image">
|
|
26
|
+
<meta name="twitter:site" content="@planbbackups">
|
|
27
|
+
<meta name="twitter:creator" content="@planbbackups">
|
|
28
|
+
<meta name="twitter:title" content="Markdown Document Standards Prompt | @knowcode/doc-builder">
|
|
29
|
+
<meta name="twitter:description" content="Use this prompt when creating or updating documentation for doc-builder projects to ensure consistency and quality.">
|
|
30
|
+
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
31
|
+
|
|
32
|
+
<!-- Custom Meta Tags -->
|
|
33
|
+
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
34
|
+
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
35
|
+
|
|
36
|
+
<!-- Fonts -->
|
|
37
|
+
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
38
|
+
|
|
39
|
+
<!-- Icons -->
|
|
40
|
+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
41
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
42
|
+
|
|
43
|
+
<!-- Mermaid -->
|
|
44
|
+
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
45
|
+
|
|
46
|
+
<!-- Styles -->
|
|
47
|
+
<link rel="stylesheet" href="/css/notion-style.css">
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
<!-- Favicon -->
|
|
52
|
+
<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>">
|
|
53
|
+
|
|
54
|
+
<script type="application/ld+json">
|
|
55
|
+
{
|
|
56
|
+
"@context": "https://schema.org",
|
|
57
|
+
"@type": "TechArticle",
|
|
58
|
+
"headline": "Markdown Document Standards Prompt",
|
|
59
|
+
"description": "Use this prompt when creating or updating documentation for doc-builder projects to ensure consistency and quality.",
|
|
60
|
+
"author": {
|
|
61
|
+
"@type": "Person",
|
|
62
|
+
"name": "Lindsay Smith"
|
|
63
|
+
},
|
|
64
|
+
"publisher": {
|
|
65
|
+
"@type": "Organization",
|
|
66
|
+
"name": "Knowcode Ltd",
|
|
67
|
+
"url": "https://knowcode.tech"
|
|
68
|
+
},
|
|
69
|
+
"datePublished": "2025-08-07T11:50:26.103Z",
|
|
70
|
+
"dateModified": "2025-08-07T11:50:26.103Z",
|
|
71
|
+
"mainEntityOfPage": {
|
|
72
|
+
"@type": "WebPage",
|
|
73
|
+
"@id": "https://doc-builder-delta.vercel.app/prompts/markdown-document-standards.html"
|
|
74
|
+
},
|
|
75
|
+
"breadcrumb": {
|
|
76
|
+
"@type": "BreadcrumbList",
|
|
77
|
+
"itemListElement": [
|
|
78
|
+
{
|
|
79
|
+
"@type": "ListItem",
|
|
80
|
+
"position": 1,
|
|
81
|
+
"name": "@knowcode/doc-builder",
|
|
82
|
+
"item": "https://doc-builder-delta.vercel.app"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"@type": "ListItem",
|
|
86
|
+
"position": 2,
|
|
87
|
+
"name": "Prompts",
|
|
88
|
+
"item": "https://doc-builder-delta.vercel.app/prompts/"
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"@type": "ListItem",
|
|
92
|
+
"position": 3,
|
|
93
|
+
"name": "Markdown Document Standards",
|
|
94
|
+
"item": "https://doc-builder-delta.vercel.app/prompts/markdown-document-standards.html"
|
|
95
|
+
}
|
|
96
|
+
]
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
</script>
|
|
100
|
+
</head>
|
|
101
|
+
<body>
|
|
102
|
+
<!-- Header -->
|
|
103
|
+
<header class="header">
|
|
104
|
+
<div class="header-content">
|
|
105
|
+
<a href="/index.html" class="logo">@knowcode/doc-builder</a>
|
|
106
|
+
|
|
107
|
+
<div class="header-actions">
|
|
108
|
+
<div class="deployment-info">
|
|
109
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.20">Last updated: Aug 7, 2025, 11:50 AM UTC</span>
|
|
110
|
+
</div>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
115
|
+
<i class="fas fa-moon"></i>
|
|
116
|
+
</button>
|
|
117
|
+
|
|
118
|
+
<button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
|
|
119
|
+
<i class="fas fa-bars"></i>
|
|
120
|
+
</button>
|
|
121
|
+
</div>
|
|
122
|
+
</div>
|
|
123
|
+
</header>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
<!-- Breadcrumbs -->
|
|
128
|
+
<nav class="breadcrumbs" id="breadcrumbs">
|
|
129
|
+
<!-- Breadcrumbs will be generated by JavaScript -->
|
|
130
|
+
</nav>
|
|
131
|
+
|
|
132
|
+
<!-- Main Content -->
|
|
133
|
+
<div class="main-wrapper">
|
|
134
|
+
<!-- Sidebar -->
|
|
135
|
+
<aside class="sidebar">
|
|
136
|
+
<div class="sidebar-header">
|
|
137
|
+
<div class="filter-box">
|
|
138
|
+
<input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
|
|
139
|
+
<i class="fas fa-search filter-icon"></i>
|
|
140
|
+
</div>
|
|
141
|
+
</div>
|
|
142
|
+
<nav class="navigation">
|
|
143
|
+
|
|
144
|
+
<div class="nav-section" data-level="0">
|
|
145
|
+
<a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
|
|
146
|
+
<i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
|
|
147
|
+
</a>
|
|
148
|
+
<div class="nav-content">
|
|
149
|
+
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
|
|
150
|
+
<a href="/about-doc-builder.html" class="nav-item" data-tooltip="About @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> About Doc Builder</a>
|
|
151
|
+
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Index</a>
|
|
152
|
+
<a href="/image-modal-test.html" class="nav-item" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="ph ph-file-text"></i> Image Modal Test</a>
|
|
153
|
+
<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="ph ph-check-circle" style="color: #059669;"></i> Vercel Cli Setup Guide</a>
|
|
154
|
+
<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="ph ph-check-circle" style="color: #059669;"></i> Vercel First Time Setup Guide</a></div></div>
|
|
155
|
+
<div class="nav-section" data-level="1">
|
|
156
|
+
<a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
|
|
157
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
|
|
158
|
+
</a>
|
|
159
|
+
<div class="nav-content collapsed" id="nav-guides-1">
|
|
160
|
+
<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="ph ph-file-text"></i> Authentication Default Change</a>
|
|
161
|
+
<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="ph ph-check-circle" style="color: #059669;"></i> Authentication Guide</a>
|
|
162
|
+
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Claude Workflow Guide</a>
|
|
163
|
+
<a href="/guides/configuration-guide.html" class="nav-item" data-tooltip="This guide explains how @knowcode/doc-builder handles configuration files and settings."><i class="ph ph-check-circle" style="color: #059669;"></i> Configuration Guide</a>
|
|
164
|
+
<a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Standards</a>
|
|
165
|
+
<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="ph ph-check-circle" style="color: #059669;"></i> Html Embedding Guide</a>
|
|
166
|
+
<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="ph ph-check-circle" style="color: #059669;"></i> Image Modal Guide</a>
|
|
167
|
+
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Phosphor Icons Guide</a>
|
|
168
|
+
<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="ph ph-check-circle" style="color: #059669;"></i> Private Directory Authentication</a>
|
|
169
|
+
<a href="/guides/private-directory-authentication-troubleshooting.html" class="nav-item" data-tooltip="Private Directory Authentication Troubleshooting."><i class="ph ph-check-circle" style="color: #059669;"></i> Private Directory Authentication Troubleshooting</a>
|
|
170
|
+
<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="ph ph-check-circle" style="color: #059669;"></i> Public Site Deployment</a>
|
|
171
|
+
<a href="/guides/search-engine-verification-guide.html" class="nav-item" data-tooltip="Search engine verification provides access to powerful webmaster tools:."><i class="ph ph-check-circle" style="color: #059669;"></i> Search Engine Verification Guide</a>
|
|
172
|
+
<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="ph ph-check-circle" style="color: #059669;"></i> Seo Guide</a>
|
|
173
|
+
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings."><i class="ph ph-check-circle" style="color: #059669;"></i> SEO Optimization Guide for @knowcode/doc-builder</a>
|
|
174
|
+
<a href="/guides/supabase-authentication-complete-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes built-in Supabase authentication that provides enterprise-grade security with zero configuration."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Authentication Complete Guide</a>
|
|
175
|
+
<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="ph ph-check-circle" style="color: #059669;"></i> Troubleshooting Guide</a>
|
|
176
|
+
<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="ph ph-check-circle" style="color: #059669;"></i> Windows Setup Guide</a></div></div>
|
|
177
|
+
<div class="nav-section" data-level="1">
|
|
178
|
+
<a class="nav-title collapsible expanded" href="#" data-target="nav-prompts-1" >
|
|
179
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
|
|
180
|
+
</a>
|
|
181
|
+
<div class="nav-content" id="nav-prompts-1">
|
|
182
|
+
<a href="/prompts/beautiful-documentation-design.html" class="nav-item" data-tooltip="🎨 Beautiful Documentation Design Guide."><i class="ph ph-check-circle" style="color: #059669;"></i> Beautiful Documentation Design</a>
|
|
183
|
+
<a href="/prompts/markdown-document-standards.html" class="nav-item active" data-tooltip="Detailed introduction to the topic..."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Markdown Document Standards</a>
|
|
184
|
+
<a href="/prompts/project-rename-strategy-sasha-publish.html" class="nav-item" data-tooltip="This document outlines the comprehensive strategy for renaming the @knowcode/doc-builder project to "sasha-publish", including all package references,..."><i class="ph ph-x-circle" style="color: #dc2626;"></i> Project Rename Strategy Sasha Publish</a></div></div>
|
|
185
|
+
<div class="nav-section" data-level="1">
|
|
186
|
+
<a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
|
|
187
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
|
|
188
|
+
</a>
|
|
189
|
+
<div class="nav-content collapsed" id="nav-test-questions-1">
|
|
190
|
+
<a href="/test-questions/how-does-it-work%3F.html" class="nav-item" data-tooltip="This is a test file to verify that question marks work properly in filenames."><i class="ph ph-file-text"></i> How Does It Work?</a>
|
|
191
|
+
<a href="/test-questions/step-1%3A%20getting-started.html" class="nav-item" data-tooltip="Step 1: Getting Started."><i class="ph ph-file-text"></i> Step 1: Getting Started</a>
|
|
192
|
+
<a href="/test-questions/what-is-the-purpose.html" class="nav-item" data-tooltip="Understanding the purpose of our documentation system"><i class="ph ph-file-text"></i> What Is The Purpose?</a></div></div>
|
|
193
|
+
</nav>
|
|
194
|
+
<div class="resize-handle"></div>
|
|
195
|
+
</aside>
|
|
196
|
+
|
|
197
|
+
<!-- Content Area -->
|
|
198
|
+
<main class="content">
|
|
199
|
+
<div class="content-inner">
|
|
200
|
+
<h1>Markdown Document Standards Prompt</h1>
|
|
201
|
+
<p>Use this prompt when creating or updating documentation for doc-builder projects to ensure consistency and quality.</p>
|
|
202
|
+
<h2>Prompt</h2>
|
|
203
|
+
<p>Please follow these markdown documentation standards when creating or editing documents:</p>
|
|
204
|
+
<h3>1. Document Structure</h3>
|
|
205
|
+
<p><strong>Required Elements:</strong></p>
|
|
206
|
+
<ul>
|
|
207
|
+
<li>Start with a clear H1 title (<code># Document Title</code>)</li>
|
|
208
|
+
<li>Include a brief overview paragraph immediately after the title</li>
|
|
209
|
+
<li>Use hierarchical heading structure (H2 for main sections, H3 for subsections)</li>
|
|
210
|
+
<li>End with a summary or conclusion when appropriate</li>
|
|
211
|
+
</ul>
|
|
212
|
+
<p><strong>Example Structure:</strong></p>
|
|
213
|
+
<pre><code class="language-markdown"># Feature Guide Title
|
|
214
|
+
|
|
215
|
+
Brief overview explaining what this document covers and why it's important.
|
|
216
|
+
|
|
217
|
+
## Overview
|
|
218
|
+
Detailed introduction to the topic...
|
|
219
|
+
|
|
220
|
+
## Main Section
|
|
221
|
+
### Subsection
|
|
222
|
+
Content...
|
|
223
|
+
|
|
224
|
+
## Conclusion
|
|
225
|
+
Summary of key points...
|
|
226
|
+
</code></pre>
|
|
227
|
+
<h3>2. File Naming Conventions</h3>
|
|
228
|
+
<ul>
|
|
229
|
+
<li>Use lowercase with hyphens: <code>feature-name-guide.md</code></li>
|
|
230
|
+
<li>Be descriptive but concise: <code>authentication-setup.md</code> not <code>auth.md</code></li>
|
|
231
|
+
<li>Use standard suffixes:<ul>
|
|
232
|
+
<li><code>-guide.md</code> for how-to guides</li>
|
|
233
|
+
<li><code>-reference.md</code> for API/technical references</li>
|
|
234
|
+
<li><code>-overview.md</code> for conceptual explanations</li>
|
|
235
|
+
<li><code>-troubleshooting.md</code> for problem-solving docs</li>
|
|
236
|
+
</ul>
|
|
237
|
+
</li>
|
|
238
|
+
</ul>
|
|
239
|
+
<h3>3. Image Guidelines</h3>
|
|
240
|
+
<p><strong>When including images:</strong></p>
|
|
241
|
+
<ul>
|
|
242
|
+
<li>Always use meaningful alt text that describes the image content</li>
|
|
243
|
+
<li>Store images in an <code>images/</code> or <code>assets/</code> subdirectory</li>
|
|
244
|
+
<li>Use descriptive filenames: <code>authentication-flow-diagram.png</code> not <code>img1.png</code></li>
|
|
245
|
+
</ul>
|
|
246
|
+
<p><strong>Image Markdown Format:</strong></p>
|
|
247
|
+
<pre><code class="language-markdown">
|
|
248
|
+
</code></pre>
|
|
249
|
+
<p><strong>Good Alt Text Examples:</strong></p>
|
|
250
|
+
<ul>
|
|
251
|
+
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <code></code></li>
|
|
252
|
+
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <code></code></li>
|
|
253
|
+
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <code></code></li>
|
|
254
|
+
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <code></code></li>
|
|
255
|
+
</ul>
|
|
256
|
+
<h3>4. Code Examples</h3>
|
|
257
|
+
<p><strong>Code Block Requirements:</strong></p>
|
|
258
|
+
<ul>
|
|
259
|
+
<li>Always specify the language for syntax highlighting</li>
|
|
260
|
+
<li>Include comments for complex code</li>
|
|
261
|
+
<li>Show both correct and incorrect usage when relevant</li>
|
|
262
|
+
<li>Keep examples concise and focused</li>
|
|
263
|
+
</ul>
|
|
264
|
+
<pre><code class="language-javascript">// Good example with language specified
|
|
265
|
+
const config = {
|
|
266
|
+
siteName: 'My Documentation',
|
|
267
|
+
features: {
|
|
268
|
+
authentication: true
|
|
269
|
+
}
|
|
270
|
+
};
|
|
271
|
+
</code></pre>
|
|
272
|
+
<h3>5. Special Folders and Files</h3>
|
|
273
|
+
<p><strong>Navigation Control:</strong></p>
|
|
274
|
+
<ul>
|
|
275
|
+
<li>Files/folders starting with <code>_</code> are excluded from navigation</li>
|
|
276
|
+
<li>Use for drafts: <code>_draft-feature.md</code></li>
|
|
277
|
+
<li>Use for internal notes: <code>_internal/planning.md</code></li>
|
|
278
|
+
</ul>
|
|
279
|
+
<p><strong>Special Files:</strong></p>
|
|
280
|
+
<ul>
|
|
281
|
+
<li><code>README.md</code> in any folder becomes the folder's overview page</li>
|
|
282
|
+
<li><code>index.md</code> takes priority over <code>README.md</code> for the main page</li>
|
|
283
|
+
</ul>
|
|
284
|
+
<h3>6. Content Guidelines</h3>
|
|
285
|
+
<p><strong>Writing Style:</strong></p>
|
|
286
|
+
<ul>
|
|
287
|
+
<li>Use clear, concise language</li>
|
|
288
|
+
<li>Write in active voice</li>
|
|
289
|
+
<li>Use present tense for instructions</li>
|
|
290
|
+
<li>Include examples whenever possible</li>
|
|
291
|
+
</ul>
|
|
292
|
+
<p><strong>Lists and Tables:</strong></p>
|
|
293
|
+
<ul>
|
|
294
|
+
<li>Use bullet points for unordered information</li>
|
|
295
|
+
<li>Use numbered lists for sequential steps</li>
|
|
296
|
+
<li>Include tables for comparing options or listing parameters</li>
|
|
297
|
+
</ul>
|
|
298
|
+
<p><strong>Links:</strong></p>
|
|
299
|
+
<ul>
|
|
300
|
+
<li>Use descriptive link text: <code>[See the authentication guide](auth-guide.md)</code></li>
|
|
301
|
+
<li>Never use "click here" or bare URLs</li>
|
|
302
|
+
<li>Prefer relative links for internal documentation</li>
|
|
303
|
+
</ul>
|
|
304
|
+
<h3>7. Front Matter (Optional)</h3>
|
|
305
|
+
<p>For SEO and page customization:</p>
|
|
306
|
+
<pre><code class="language-yaml">---
|
|
307
|
+
title: Custom Page Title
|
|
308
|
+
description: Brief description for SEO
|
|
309
|
+
keywords: authentication, setup, configuration
|
|
310
|
+
---
|
|
311
|
+
</code></pre>
|
|
312
|
+
<h3>8. Accessibility</h3>
|
|
313
|
+
<ul>
|
|
314
|
+
<li>Use proper heading hierarchy (don't skip levels)</li>
|
|
315
|
+
<li>Include alt text for all images</li>
|
|
316
|
+
<li>Use descriptive link text</li>
|
|
317
|
+
<li>Ensure code examples are screen-reader friendly</li>
|
|
318
|
+
</ul>
|
|
319
|
+
<h3>9. Mermaid Diagrams</h3>
|
|
320
|
+
<p>When using Mermaid diagrams:</p>
|
|
321
|
+
<pre><code class="language-markdown"><div class="mermaid-wrapper">
|
|
322
|
+
<div class="mermaid">graph TD
|
|
323
|
+
A[Start] --> B{Decision}
|
|
324
|
+
B -->|Yes| C[Process]
|
|
325
|
+
B -->|No| D[End]</div>
|
|
326
|
+
</div>
|
|
327
|
+
|
|
328
|
+
### 10. Version References
|
|
329
|
+
|
|
330
|
+
When mentioning version-specific features:
|
|
331
|
+
- Always specify the version: "Available in v1.8.5+"
|
|
332
|
+
- Link to changelog when discussing changes
|
|
333
|
+
- Use semantic versioning consistently
|
|
334
|
+
|
|
335
|
+
Remember: These standards ensure documentation is consistent, accessible, and easy to maintain. When in doubt, prioritize clarity and user experience.
|
|
336
|
+
</code></pre>
|
|
337
|
+
|
|
338
|
+
</div>
|
|
339
|
+
</main>
|
|
340
|
+
</div>
|
|
341
|
+
|
|
342
|
+
<!-- Scripts -->
|
|
343
|
+
<script>
|
|
344
|
+
// Pass configuration to frontend
|
|
345
|
+
window.docBuilderConfig = {
|
|
346
|
+
features: {
|
|
347
|
+
showPdfDownload: true,
|
|
348
|
+
menuDefaultOpen: false,
|
|
349
|
+
mermaidEnhanced: true
|
|
350
|
+
}
|
|
351
|
+
};
|
|
352
|
+
</script>
|
|
353
|
+
<script src="/js/main.js"></script>
|
|
354
|
+
|
|
355
|
+
</body>
|
|
356
|
+
</html>
|