@knowcode/doc-builder 1.1.12 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +63 -0
- package/assets/css/notion-style.css +264 -49
- package/lib/core-builder.js +317 -68
- package/lib/deploy.js +12 -55
- package/package.json +1 -1
- package/temp-test/docs/README.md +69 -0
- package/temp-test/docs/test-file.md +1 -0
- package/temp-test/html/README.html +164 -0
- package/temp-test/html/css/notion-style.css +1758 -0
- package/temp-test/html/css/style.css +1974 -0
- package/temp-test/html/js/auth.js +65 -0
- package/temp-test/html/js/main.js +1333 -0
- package/temp-test/html/test-file.html +101 -0
|
@@ -0,0 +1,164 @@
|
|
|
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="Documentation site built with @knowcode/doc-builder">
|
|
7
|
+
<title>Welcome to Documentation - Documentation</title>
|
|
8
|
+
|
|
9
|
+
<!-- Fonts -->
|
|
10
|
+
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
11
|
+
|
|
12
|
+
<!-- Icons -->
|
|
13
|
+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
14
|
+
|
|
15
|
+
<!-- Mermaid -->
|
|
16
|
+
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
17
|
+
|
|
18
|
+
<!-- Styles -->
|
|
19
|
+
<link rel="stylesheet" href="/css/notion-style.css">
|
|
20
|
+
<link rel="stylesheet" href="/css/style.css">
|
|
21
|
+
|
|
22
|
+
<!-- Favicon -->
|
|
23
|
+
<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>">
|
|
24
|
+
</head>
|
|
25
|
+
<body>
|
|
26
|
+
<!-- Header -->
|
|
27
|
+
<header class="header">
|
|
28
|
+
<div class="header-content">
|
|
29
|
+
<a href="/index.html" class="logo">Documentation</a>
|
|
30
|
+
|
|
31
|
+
<div class="header-actions">
|
|
32
|
+
<div class="deployment-info">
|
|
33
|
+
<span class="deployment-date">Last updated: Jul 19, 2025, 11:59 AM UTC</span>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
39
|
+
<i class="fas fa-moon"></i>
|
|
40
|
+
</button>
|
|
41
|
+
|
|
42
|
+
<button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
|
|
43
|
+
<i class="fas fa-bars"></i>
|
|
44
|
+
</button>
|
|
45
|
+
</div>
|
|
46
|
+
</div>
|
|
47
|
+
</header>
|
|
48
|
+
|
|
49
|
+
<!-- Preview Banner -->
|
|
50
|
+
<div id="preview-banner" class="preview-banner">
|
|
51
|
+
<div class="banner-content">
|
|
52
|
+
<i class="fas fa-exclamation-triangle banner-icon"></i>
|
|
53
|
+
<span class="banner-text">This documentation is a preview version - some content may be incomplete</span>
|
|
54
|
+
<button id="dismiss-banner" class="banner-dismiss" aria-label="Dismiss banner">
|
|
55
|
+
<i class="fas fa-times"></i>
|
|
56
|
+
</button>
|
|
57
|
+
</div>
|
|
58
|
+
</div>
|
|
59
|
+
|
|
60
|
+
<!-- Breadcrumbs -->
|
|
61
|
+
<nav class="breadcrumbs" id="breadcrumbs">
|
|
62
|
+
<!-- Breadcrumbs will be generated by JavaScript -->
|
|
63
|
+
</nav>
|
|
64
|
+
|
|
65
|
+
<!-- Main Content -->
|
|
66
|
+
<div class="main-wrapper">
|
|
67
|
+
<!-- Sidebar -->
|
|
68
|
+
<aside class="sidebar">
|
|
69
|
+
<div class="sidebar-header">
|
|
70
|
+
<div class="filter-box">
|
|
71
|
+
<input type="text" placeholder="Filter items..." class="filter-input" id="nav-filter">
|
|
72
|
+
<i class="fas fa-search filter-icon"></i>
|
|
73
|
+
</div>
|
|
74
|
+
</div>
|
|
75
|
+
<nav class="navigation">
|
|
76
|
+
|
|
77
|
+
<div class="nav-section" data-level="0">
|
|
78
|
+
<a class="nav-title expanded" href="/README.html" >
|
|
79
|
+
<i class="fas fa-home"></i> Documentation
|
|
80
|
+
</a>
|
|
81
|
+
<div class="nav-content" >
|
|
82
|
+
<a href="/README.html" class="nav-item active"><i class="fas fa-file-alt"></i> Overview</a>
|
|
83
|
+
<a href="/test-file.html" class="nav-item"><i class="fas fa-file-alt"></i> Test File</a></div></div>
|
|
84
|
+
</nav>
|
|
85
|
+
<div class="resize-handle"></div>
|
|
86
|
+
</aside>
|
|
87
|
+
|
|
88
|
+
<!-- Content Area -->
|
|
89
|
+
<main class="content">
|
|
90
|
+
<div class="content-inner">
|
|
91
|
+
<h1>Welcome to Documentation</h1>
|
|
92
|
+
<p><strong>Generated</strong>: 2025-07-19 UTC<br><strong>Status</strong>: Placeholder - Ready for customization<br><strong>Verified</strong>: ❓ (Auto-generated content)</p>
|
|
93
|
+
<h2>Overview</h2>
|
|
94
|
+
<p>This documentation site was built with @knowcode/doc-builder. This is an auto-generated placeholder to help you get started.</p>
|
|
95
|
+
<h2>Getting Started</h2>
|
|
96
|
+
<ol>
|
|
97
|
+
<li><strong>Replace this file</strong>: Edit <code>docs/README.md</code> with your project's actual documentation</li>
|
|
98
|
+
<li><strong>Add content</strong>: Create additional markdown files in the <code>docs/</code> directory</li>
|
|
99
|
+
<li><strong>Organize with folders</strong>: Use subfolders to structure your documentation</li>
|
|
100
|
+
<li><strong>Rebuild</strong>: Run <code>npx @knowcode/doc-builder build</code> to regenerate the site</li>
|
|
101
|
+
</ol>
|
|
102
|
+
<h2>Documentation Structure</h2>
|
|
103
|
+
<p>Your documentation can include:</p>
|
|
104
|
+
<ul>
|
|
105
|
+
<li><strong>Overview</strong>: Main project description (this file)</li>
|
|
106
|
+
<li><strong>Guides</strong>: Step-by-step tutorials</li>
|
|
107
|
+
<li><strong>API Reference</strong>: Technical documentation</li>
|
|
108
|
+
<li><strong>Examples</strong>: Code samples and usage</li>
|
|
109
|
+
<li><strong>Architecture</strong>: System design and technical details</li>
|
|
110
|
+
</ul>
|
|
111
|
+
<h2>Next Steps</h2>
|
|
112
|
+
<ol>
|
|
113
|
+
<li>Edit this README.md file with your project information</li>
|
|
114
|
+
<li>Create additional markdown files for your content</li>
|
|
115
|
+
<li>Organize files into logical folders</li>
|
|
116
|
+
<li>Use Mermaid diagrams for visual explanations</li>
|
|
117
|
+
<li>Deploy with <code>npx @knowcode/doc-builder deploy</code></li>
|
|
118
|
+
</ol>
|
|
119
|
+
<h2>Documentation Standards</h2>
|
|
120
|
+
<p>This project follows structured documentation conventions:</p>
|
|
121
|
+
<h3>File Organization</h3>
|
|
122
|
+
<ul>
|
|
123
|
+
<li>Use descriptive filenames with hyphens (e.g., <code>user-guide.md</code>)</li>
|
|
124
|
+
<li>Organize related content in folders</li>
|
|
125
|
+
<li>Include a README.md in each major folder</li>
|
|
126
|
+
</ul>
|
|
127
|
+
<h3>Content Format</h3>
|
|
128
|
+
<ul>
|
|
129
|
+
<li>Start each document with metadata (Generated date, Status, Verified status)</li>
|
|
130
|
+
<li>Use clear headings and consistent structure</li>
|
|
131
|
+
<li>Include diagrams where helpful to explain concepts</li>
|
|
132
|
+
<li>Mark information as verified (✅) or speculated (❓)</li>
|
|
133
|
+
</ul>
|
|
134
|
+
<h3>Mermaid Diagrams</h3>
|
|
135
|
+
<p>Include visual diagrams to explain complex concepts:</p>
|
|
136
|
+
<div class="mermaid-wrapper">
|
|
137
|
+
<div class="mermaid-title">Diagram</div>
|
|
138
|
+
<div class="mermaid">graph TD
|
|
139
|
+
A[Start Documentation] --> B{Have Content?}
|
|
140
|
+
B -->|Yes| C[Edit README.md]
|
|
141
|
+
B -->|No| D[Create Content Files]
|
|
142
|
+
C --> E[Build & Deploy]
|
|
143
|
+
D --> E
|
|
144
|
+
E --> F[Share Documentation]
|
|
145
|
+
</div>
|
|
146
|
+
</div>
|
|
147
|
+
|
|
148
|
+
<h2>Support</h2>
|
|
149
|
+
<p>For help with @knowcode/doc-builder:</p>
|
|
150
|
+
<ul>
|
|
151
|
+
<li>Check the documentation at your package source</li>
|
|
152
|
+
<li>Use <code>npx @knowcode/doc-builder --help</code> for CLI options</li>
|
|
153
|
+
<li>Review the generated configuration guide if available</li>
|
|
154
|
+
</ul>
|
|
155
|
+
|
|
156
|
+
</div>
|
|
157
|
+
</main>
|
|
158
|
+
</div>
|
|
159
|
+
|
|
160
|
+
<!-- Scripts -->
|
|
161
|
+
<script src="/js/main.js"></script>
|
|
162
|
+
|
|
163
|
+
</body>
|
|
164
|
+
</html>
|