@knowcode/doc-builder 1.4.5 → 1.4.7
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 +23 -0
- package/README.md +18 -2
- package/Screenshot 2025-07-21 at 11.52.33.png +0 -0
- package/assets/css/notion-style.css +2 -46
- package/html/README.html +1 -1
- package/html/css/notion-style.css +2 -46
- package/html/index.html +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,29 @@ 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.7] - 2025-07-21
|
|
9
|
+
|
|
10
|
+
### Fixed
|
|
11
|
+
- Removed excess spacing above navigation menu by setting sidebar-header margin-bottom to 0
|
|
12
|
+
- Cleaned up duplicate `.sidebar-header` CSS definitions that were causing conflicts
|
|
13
|
+
|
|
14
|
+
### Background
|
|
15
|
+
- Previous CSS fixes exposed duplicate `.sidebar-header` definitions with conflicting margins
|
|
16
|
+
- The extra spacing was introduced by `margin-bottom: var(--space-4)` on the sidebar header
|
|
17
|
+
- This completes the CSS cleanup started in v1.4.5 and v1.4.6
|
|
18
|
+
|
|
19
|
+
## [1.4.6] - 2025-07-21
|
|
20
|
+
|
|
21
|
+
### Fixed
|
|
22
|
+
- Restored breadcrumb height from 0px to 40px to fix visibility issue
|
|
23
|
+
- Removed duplicate CSS rules that were causing filter icon overlap
|
|
24
|
+
- Cleaned up duplicate `.filter-box`, `.filter-icon`, and `.sidebar-breadcrumbs` definitions
|
|
25
|
+
|
|
26
|
+
### Background
|
|
27
|
+
- The removal of style.css in v1.4.5 exposed pre-existing CSS conflicts
|
|
28
|
+
- Duplicate CSS rules were causing the filter icon to render incorrectly
|
|
29
|
+
- Breadcrumb height of 0px (set in v1.3.2) made the breadcrumb bar invisible
|
|
30
|
+
|
|
8
31
|
## [1.4.5] - 2025-07-21
|
|
9
32
|
|
|
10
33
|
### Fixed
|
package/README.md
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
# @knowcode/doc-builder
|
|
2
2
|
|
|
3
|
-
A zero-configuration documentation builder
|
|
3
|
+
Beautiful documentation with the least effort possible. A zero-configuration documentation builder that transforms markdown files into stunning static sites.
|
|
4
|
+
|
|
5
|
+
## Why This Project Exists
|
|
6
|
+
|
|
7
|
+
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.
|
|
4
8
|
|
|
5
9
|
## What It Does
|
|
6
10
|
|
|
@@ -9,11 +13,23 @@ A zero-configuration documentation builder for markdown-based sites with Vercel
|
|
|
9
13
|
- **Scans** your markdown files and automatically generates navigation
|
|
10
14
|
- **Converts** markdown to HTML with syntax highlighting and diagram support
|
|
11
15
|
- **Styles** everything with a clean, Notion-inspired theme
|
|
12
|
-
- **Deploys** to Vercel with a single command -
|
|
16
|
+
- **Deploys** to Vercel with a single command - leveraging their generous free tier
|
|
13
17
|
- **Provides** optional features like authentication, dark mode, and changelog generation
|
|
14
18
|
|
|
15
19
|
Perfect for project documentation, API references, knowledge bases, or any content written in markdown.
|
|
16
20
|
|
|
21
|
+
## Why Vercel?
|
|
22
|
+
|
|
23
|
+
We chose Vercel as our deployment platform because of their **generous free tier** that includes:
|
|
24
|
+
- Unlimited personal projects
|
|
25
|
+
- Automatic HTTPS certificates
|
|
26
|
+
- Global CDN for fast loading worldwide
|
|
27
|
+
- Custom domains support
|
|
28
|
+
- Automatic deployments from Git
|
|
29
|
+
- No credit card required
|
|
30
|
+
|
|
31
|
+
This aligns perfectly with our mission: beautiful documentation should be accessible to everyone, without worrying about hosting costs or complex server management.
|
|
32
|
+
|
|
17
33
|
## Features
|
|
18
34
|
|
|
19
35
|
- 🚀 **Zero Configuration** - Works out of the box with sensible defaults
|
|
Binary file
|
|
@@ -126,7 +126,7 @@
|
|
|
126
126
|
--container-padding-mobile: 20px;
|
|
127
127
|
--container-padding-desktop: 40px;
|
|
128
128
|
--header-height: 40px;
|
|
129
|
-
--breadcrumb-height:
|
|
129
|
+
--breadcrumb-height: 40px;
|
|
130
130
|
--sidebar-width: 280px;
|
|
131
131
|
}
|
|
132
132
|
|
|
@@ -333,16 +333,6 @@ pre code {
|
|
|
333
333
|
top: calc(var(--header-height) + var(--breadcrumb-height) + 3.5rem);
|
|
334
334
|
}
|
|
335
335
|
|
|
336
|
-
.sidebar-header {
|
|
337
|
-
padding: var(--space-4);
|
|
338
|
-
border-bottom: 1px solid var(--color-border-default);
|
|
339
|
-
margin-bottom: var(--space-4);
|
|
340
|
-
}
|
|
341
|
-
|
|
342
|
-
/* Sidebar Breadcrumbs */
|
|
343
|
-
.sidebar-breadcrumbs {
|
|
344
|
-
margin-bottom: var(--space-3);
|
|
345
|
-
}
|
|
346
336
|
|
|
347
337
|
.sidebar-home-link {
|
|
348
338
|
display: inline-flex;
|
|
@@ -529,43 +519,9 @@ pre code {
|
|
|
529
519
|
.sidebar-header {
|
|
530
520
|
padding: var(--space-3);
|
|
531
521
|
border-bottom: 1px solid var(--color-border-default);
|
|
532
|
-
margin-bottom:
|
|
533
|
-
}
|
|
534
|
-
|
|
535
|
-
/* Already defined above, but ensure consistency */
|
|
536
|
-
.sidebar-breadcrumbs {
|
|
537
|
-
margin-bottom: var(--space-3);
|
|
538
|
-
}
|
|
539
|
-
|
|
540
|
-
.filter-box {
|
|
541
|
-
position: relative;
|
|
542
|
-
display: flex;
|
|
543
|
-
align-items: center;
|
|
544
|
-
}
|
|
545
|
-
|
|
546
|
-
.filter-input {
|
|
547
|
-
width: 100%;
|
|
548
|
-
padding: var(--space-2) var(--space-8) var(--space-2) var(--space-3);
|
|
549
|
-
border: 1px solid var(--color-border-default);
|
|
550
|
-
border-radius: var(--radius-md);
|
|
551
|
-
background: var(--color-bg-default);
|
|
552
|
-
color: var(--color-text-primary);
|
|
553
|
-
font-size: var(--text-sm);
|
|
554
|
-
transition: all var(--duration-fast);
|
|
555
|
-
}
|
|
556
|
-
|
|
557
|
-
.filter-input:focus {
|
|
558
|
-
outline: none;
|
|
559
|
-
border-color: var(--color-border-focus);
|
|
560
|
-
box-shadow: 0 0 0 2px var(--color-accent-blue-bg);
|
|
522
|
+
margin-bottom: 0;
|
|
561
523
|
}
|
|
562
524
|
|
|
563
|
-
.filter-icon {
|
|
564
|
-
position: absolute;
|
|
565
|
-
right: var(--space-3);
|
|
566
|
-
color: var(--color-text-tertiary);
|
|
567
|
-
pointer-events: none;
|
|
568
|
-
}
|
|
569
525
|
|
|
570
526
|
/* Navigation */
|
|
571
527
|
.navigation {
|
package/html/README.html
CHANGED
|
@@ -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.6">Last updated: Jul 21, 2025, 11:05 AM UTC</span>
|
|
33
33
|
</div>
|
|
34
34
|
|
|
35
35
|
|
|
@@ -126,7 +126,7 @@
|
|
|
126
126
|
--container-padding-mobile: 20px;
|
|
127
127
|
--container-padding-desktop: 40px;
|
|
128
128
|
--header-height: 40px;
|
|
129
|
-
--breadcrumb-height:
|
|
129
|
+
--breadcrumb-height: 40px;
|
|
130
130
|
--sidebar-width: 280px;
|
|
131
131
|
}
|
|
132
132
|
|
|
@@ -333,16 +333,6 @@ pre code {
|
|
|
333
333
|
top: calc(var(--header-height) + var(--breadcrumb-height) + 3.5rem);
|
|
334
334
|
}
|
|
335
335
|
|
|
336
|
-
.sidebar-header {
|
|
337
|
-
padding: var(--space-4);
|
|
338
|
-
border-bottom: 1px solid var(--color-border-default);
|
|
339
|
-
margin-bottom: var(--space-4);
|
|
340
|
-
}
|
|
341
|
-
|
|
342
|
-
/* Sidebar Breadcrumbs */
|
|
343
|
-
.sidebar-breadcrumbs {
|
|
344
|
-
margin-bottom: var(--space-3);
|
|
345
|
-
}
|
|
346
336
|
|
|
347
337
|
.sidebar-home-link {
|
|
348
338
|
display: inline-flex;
|
|
@@ -529,43 +519,9 @@ pre code {
|
|
|
529
519
|
.sidebar-header {
|
|
530
520
|
padding: var(--space-3);
|
|
531
521
|
border-bottom: 1px solid var(--color-border-default);
|
|
532
|
-
margin-bottom:
|
|
533
|
-
}
|
|
534
|
-
|
|
535
|
-
/* Already defined above, but ensure consistency */
|
|
536
|
-
.sidebar-breadcrumbs {
|
|
537
|
-
margin-bottom: var(--space-3);
|
|
538
|
-
}
|
|
539
|
-
|
|
540
|
-
.filter-box {
|
|
541
|
-
position: relative;
|
|
542
|
-
display: flex;
|
|
543
|
-
align-items: center;
|
|
544
|
-
}
|
|
545
|
-
|
|
546
|
-
.filter-input {
|
|
547
|
-
width: 100%;
|
|
548
|
-
padding: var(--space-2) var(--space-8) var(--space-2) var(--space-3);
|
|
549
|
-
border: 1px solid var(--color-border-default);
|
|
550
|
-
border-radius: var(--radius-md);
|
|
551
|
-
background: var(--color-bg-default);
|
|
552
|
-
color: var(--color-text-primary);
|
|
553
|
-
font-size: var(--text-sm);
|
|
554
|
-
transition: all var(--duration-fast);
|
|
555
|
-
}
|
|
556
|
-
|
|
557
|
-
.filter-input:focus {
|
|
558
|
-
outline: none;
|
|
559
|
-
border-color: var(--color-border-focus);
|
|
560
|
-
box-shadow: 0 0 0 2px var(--color-accent-blue-bg);
|
|
522
|
+
margin-bottom: 0;
|
|
561
523
|
}
|
|
562
524
|
|
|
563
|
-
.filter-icon {
|
|
564
|
-
position: absolute;
|
|
565
|
-
right: var(--space-3);
|
|
566
|
-
color: var(--color-text-tertiary);
|
|
567
|
-
pointer-events: none;
|
|
568
|
-
}
|
|
569
525
|
|
|
570
526
|
/* Navigation */
|
|
571
527
|
.navigation {
|
package/html/index.html
CHANGED
|
@@ -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.6">Last updated: Jul 21, 2025, 11:05 AM UTC</span>
|
|
33
33
|
</div>
|
|
34
34
|
|
|
35
35
|
|