@knowcode/doc-builder 1.4.10 → 1.4.11
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 +6 -0
- package/README.md +2 -0
- package/html/README.html +138 -5
- package/html/claude-workflow-guide.html +2 -2
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,12 @@ All notable changes to @knowcode/doc-builder will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [1.4.11] - 2025-07-21
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- Added live example site link to npm README.md (https://doc-builder-delta.vercel.app)
|
|
12
|
+
- Users can now preview what their documentation will look like before building
|
|
13
|
+
|
|
8
14
|
## [1.4.10] - 2025-07-21
|
|
9
15
|
|
|
10
16
|
### Fixed
|
package/README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Beautiful documentation with the least effort possible. A zero-configuration documentation builder that transforms markdown files into stunning static sites.
|
|
4
4
|
|
|
5
|
+
🔗 **[View Live Example](https://doc-builder-delta.vercel.app)** - See what your documentation will look like!
|
|
6
|
+
|
|
5
7
|
## Why This Project Exists
|
|
6
8
|
|
|
7
9
|
The main premise of @knowcode/doc-builder is simple: **create beautiful documentation with the least effort possible**. We believe great documentation shouldn't require complex setup, configuration files, or deployment headaches. Just write markdown, run one command, and get a professional documentation site live on the web.
|
package/html/README.html
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
6
|
<meta name="description" content="Documentation site built with @knowcode/doc-builder">
|
|
7
|
-
<title
|
|
7
|
+
<title>@knowcode/doc-builder - Documentation</title>
|
|
8
8
|
|
|
9
9
|
<!-- Fonts -->
|
|
10
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">
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
<div class="header-actions">
|
|
31
31
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.4.
|
|
32
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.10">Last updated: Jul 21, 2025, 12:11 PM UTC</span>
|
|
33
33
|
</div>
|
|
34
34
|
|
|
35
35
|
|
|
@@ -78,7 +78,7 @@
|
|
|
78
78
|
<i class="fas fa-home"></i> Documentation
|
|
79
79
|
</a>
|
|
80
80
|
<div class="nav-content" >
|
|
81
|
-
<a href="/README.html" class="nav-item active" data-tooltip="
|
|
81
|
+
<a href="/README.html" class="nav-item active" data-tooltip="> Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling Create stunning documentation sites in minute..."><i class="fas fa-file-alt"></i> Overview</a>
|
|
82
82
|
<a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 10:00 UTC **Status**: Complete **Verified**: ✅ This guide demonstrates an efficient workflow for using Claude Code with a re..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a></div></div>
|
|
83
83
|
</nav>
|
|
84
84
|
<div class="resize-handle"></div>
|
|
@@ -87,8 +87,141 @@
|
|
|
87
87
|
<!-- Content Area -->
|
|
88
88
|
<main class="content">
|
|
89
89
|
<div class="content-inner">
|
|
90
|
-
<h1
|
|
91
|
-
<
|
|
90
|
+
<h1>@knowcode/doc-builder</h1>
|
|
91
|
+
<blockquote>
|
|
92
|
+
<p>Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling</p>
|
|
93
|
+
</blockquote>
|
|
94
|
+
<p><a href="https://www.npmjs.com/package/@knowcode/doc-builder"><img src="https://img.shields.io/npm/v/@knowcode/doc-builder" alt="npm version"></a><br><a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a></p>
|
|
95
|
+
<h2>🚀 Quick Start</h2>
|
|
96
|
+
<p>Create stunning documentation sites in minutes:</p>
|
|
97
|
+
<pre><code class="language-bash"># Install globally
|
|
98
|
+
npm install -g @knowcode/doc-builder
|
|
99
|
+
|
|
100
|
+
# Or use with npx
|
|
101
|
+
npx @knowcode/doc-builder@latest init
|
|
102
|
+
</code></pre>
|
|
103
|
+
<h2>✨ Features</h2>
|
|
104
|
+
<h3>🎨 Beautiful Design</h3>
|
|
105
|
+
<ul>
|
|
106
|
+
<li><strong>Notion-inspired UI</strong> - Clean, modern interface that users love</li>
|
|
107
|
+
<li><strong>Dark mode support</strong> - Automatic theme switching</li>
|
|
108
|
+
<li><strong>Responsive layout</strong> - Perfect on desktop and mobile</li>
|
|
109
|
+
<li><strong>Syntax highlighting</strong> - Beautiful code blocks with language support</li>
|
|
110
|
+
</ul>
|
|
111
|
+
<h3>🔍 Powerful Search & Navigation</h3>
|
|
112
|
+
<ul>
|
|
113
|
+
<li><strong>Full-text search</strong> - Find anything instantly</li>
|
|
114
|
+
<li><strong>Smart navigation</strong> - Hierarchical folder structure</li>
|
|
115
|
+
<li><strong>Breadcrumbs</strong> - Always know where you are</li>
|
|
116
|
+
<li><strong>Keyboard shortcuts</strong> - Navigate like a pro</li>
|
|
117
|
+
</ul>
|
|
118
|
+
<h3>📊 Rich Content Support</h3>
|
|
119
|
+
<ul>
|
|
120
|
+
<li><strong>Mermaid diagrams</strong> - Flowcharts, sequence diagrams, and more</li>
|
|
121
|
+
<li><strong>GitHub-flavored markdown</strong> - Tables, task lists, and strikethrough</li>
|
|
122
|
+
<li><strong>Interactive tooltips</strong> - Document summaries on hover</li>
|
|
123
|
+
<li><strong>Version tracking</strong> - Know which version built your docs</li>
|
|
124
|
+
</ul>
|
|
125
|
+
<h3>🚀 Easy Deployment</h3>
|
|
126
|
+
<ul>
|
|
127
|
+
<li><strong>One-command deploy</strong> - Push to Vercel instantly</li>
|
|
128
|
+
<li><strong>Static site generation</strong> - Fast, secure, and scalable</li>
|
|
129
|
+
<li><strong>Custom domains</strong> - Your docs, your brand</li>
|
|
130
|
+
<li><strong>Preview deployments</strong> - Test before going live</li>
|
|
131
|
+
</ul>
|
|
132
|
+
<h2>📖 Documentation</h2>
|
|
133
|
+
<p>Visit our <a href="https://www.npmjs.com/package/@knowcode/doc-builder">official documentation</a> for detailed guides and API reference.</p>
|
|
134
|
+
<h2>🎯 Perfect For</h2>
|
|
135
|
+
<ul>
|
|
136
|
+
<li><strong>Open source projects</strong> - Beautiful docs for your community</li>
|
|
137
|
+
<li><strong>Technical teams</strong> - Internal documentation that developers actually use</li>
|
|
138
|
+
<li><strong>API documentation</strong> - Clear, searchable API references</li>
|
|
139
|
+
<li><strong>Knowledge bases</strong> - Organize and share team knowledge</li>
|
|
140
|
+
</ul>
|
|
141
|
+
<h2>🛠️ Simple Workflow</h2>
|
|
142
|
+
<h3>1. Initialize Your Project</h3>
|
|
143
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder init
|
|
144
|
+
</code></pre>
|
|
145
|
+
<h3>2. Write Your Documentation</h3>
|
|
146
|
+
<p>Create markdown files in your <code>docs</code> folder:</p>
|
|
147
|
+
<pre><code class="language-markdown"># Getting Started
|
|
148
|
+
|
|
149
|
+
Welcome to our documentation!
|
|
150
|
+
|
|
151
|
+
## Installation
|
|
152
|
+
|
|
153
|
+
\`\`\`bash
|
|
154
|
+
npm install amazing-package
|
|
155
|
+
\`\`\`
|
|
156
|
+
|
|
157
|
+
## Features
|
|
158
|
+
|
|
159
|
+
- ✅ Feature one
|
|
160
|
+
- ✅ Feature two
|
|
161
|
+
- ✅ Feature three
|
|
162
|
+
</code></pre>
|
|
163
|
+
<h3>3. Build & Preview</h3>
|
|
164
|
+
<pre><code class="language-bash"># Build your site
|
|
165
|
+
npx doc-builder build
|
|
166
|
+
|
|
167
|
+
# Preview locally
|
|
168
|
+
npx doc-builder serve
|
|
169
|
+
</code></pre>
|
|
170
|
+
<h3>4. Deploy to Vercel</h3>
|
|
171
|
+
<pre><code class="language-bash">npx doc-builder deploy
|
|
172
|
+
</code></pre>
|
|
173
|
+
<h2>🎨 Customization</h2>
|
|
174
|
+
<p>Configure your site with <code>doc-builder.config.js</code>:</p>
|
|
175
|
+
<pre><code class="language-javascript">module.exports = {
|
|
176
|
+
siteName: 'Your Amazing Docs',
|
|
177
|
+
siteDescription: 'Documentation that developers love',
|
|
178
|
+
features: {
|
|
179
|
+
mermaid: true,
|
|
180
|
+
darkMode: true,
|
|
181
|
+
authentication: false
|
|
182
|
+
}
|
|
183
|
+
};
|
|
184
|
+
</code></pre>
|
|
185
|
+
<h2>📊 Mermaid Diagram Support</h2>
|
|
186
|
+
<p>Create beautiful diagrams in your markdown:</p>
|
|
187
|
+
<div class="mermaid-wrapper">
|
|
188
|
+
<div class="mermaid-title">Diagram</div>
|
|
189
|
+
<div class="mermaid">graph LR
|
|
190
|
+
A[Write Docs] --> B[Build Site]
|
|
191
|
+
B --> C[Deploy]
|
|
192
|
+
C --> D[Share Knowledge]
|
|
193
|
+
|
|
194
|
+
style A fill:#e1f5fe
|
|
195
|
+
style D fill:#c8e6c9</div>
|
|
196
|
+
</div>
|
|
197
|
+
<h2>🔒 Optional Authentication</h2>
|
|
198
|
+
<p>Protect sensitive documentation with built-in authentication:</p>
|
|
199
|
+
<pre><code class="language-javascript">features: {
|
|
200
|
+
authentication: true
|
|
201
|
+
}
|
|
202
|
+
</code></pre>
|
|
203
|
+
<h2>🌟 Why doc-builder?</h2>
|
|
204
|
+
<ul>
|
|
205
|
+
<li><strong>Zero configuration</strong> - Works out of the box</li>
|
|
206
|
+
<li><strong>Lightning fast</strong> - Static site generation for instant loading</li>
|
|
207
|
+
<li><strong>SEO friendly</strong> - Optimized for search engines</li>
|
|
208
|
+
<li><strong>Accessible</strong> - WCAG compliant</li>
|
|
209
|
+
<li><strong>Version control</strong> - Track changes with Git</li>
|
|
210
|
+
<li><strong>Open source</strong> - MIT licensed</li>
|
|
211
|
+
</ul>
|
|
212
|
+
<h2>🤝 Contributing</h2>
|
|
213
|
+
<p>We welcome contributions! Check out our <a href="https://github.com/knowcode/doc-builder">contribution guide</a> to get started.</p>
|
|
214
|
+
<h2>📝 License</h2>
|
|
215
|
+
<p>MIT © KnowCode</p>
|
|
216
|
+
<hr>
|
|
217
|
+
<div align="center">
|
|
218
|
+
<p>Built with ❤️ by developers, for developers</p>
|
|
219
|
+
<p>
|
|
220
|
+
<a href="https://www.npmjs.com/package/@knowcode/doc-builder">npm</a> •
|
|
221
|
+
<a href="https://github.com/knowcode/doc-builder">GitHub</a> •
|
|
222
|
+
<a href="https://knowcode.com">Website</a>
|
|
223
|
+
</p>
|
|
224
|
+
</div>
|
|
92
225
|
|
|
93
226
|
</div>
|
|
94
227
|
</main>
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
<div class="header-actions">
|
|
31
31
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.4.
|
|
32
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.10">Last updated: Jul 21, 2025, 12:11 PM UTC</span>
|
|
33
33
|
</div>
|
|
34
34
|
|
|
35
35
|
|
|
@@ -78,7 +78,7 @@
|
|
|
78
78
|
<i class="fas fa-home"></i> Documentation
|
|
79
79
|
</a>
|
|
80
80
|
<div class="nav-content" >
|
|
81
|
-
<a href="/README.html" class="nav-item" data-tooltip="
|
|
81
|
+
<a href="/README.html" class="nav-item" data-tooltip="> Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling Create stunning documentation sites in minute..."><i class="fas fa-file-alt"></i> Overview</a>
|
|
82
82
|
<a href="/claude-workflow-guide.html" class="nav-item active" data-tooltip="**Generated**: 2025-07-21 10:00 UTC **Status**: Complete **Verified**: ✅ This guide demonstrates an efficient workflow for using Claude Code with a re..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a></div></div>
|
|
83
83
|
</nav>
|
|
84
84
|
<div class="resize-handle"></div>
|