@knowcode/doc-builder 1.4.4 ā 1.4.6
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 +8 -1
- package/CHANGELOG.md +24 -0
- package/README.md +18 -2
- package/Screenshot 2025-07-21 at 11.52.33.png +0 -0
- package/assets/css/notion-style.css +1 -35
- package/html/README.html +1 -2
- package/html/css/notion-style.css +1 -35
- package/html/index.html +1 -2
- package/lib/core-builder.js +0 -2
- package/lib/deploy.js +1 -2
- package/package.json +1 -1
|
@@ -8,7 +8,14 @@
|
|
|
8
8
|
"Bash(npm pack)",
|
|
9
9
|
"Bash(cat:*)",
|
|
10
10
|
"Bash(rm:*)",
|
|
11
|
-
"Bash(npm publish:*)"
|
|
11
|
+
"Bash(npm publish:*)",
|
|
12
|
+
"Bash(git tag:*)",
|
|
13
|
+
"Bash(git push:*)",
|
|
14
|
+
"Bash(git pull:*)",
|
|
15
|
+
"Bash(git rebase:*)",
|
|
16
|
+
"Bash(npm info:*)",
|
|
17
|
+
"Bash(npx:*)",
|
|
18
|
+
"Bash(grep:*)"
|
|
12
19
|
],
|
|
13
20
|
"deny": []
|
|
14
21
|
}
|
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,30 @@ 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.6] - 2025-07-21
|
|
9
|
+
|
|
10
|
+
### Fixed
|
|
11
|
+
- Restored breadcrumb height from 0px to 40px to fix visibility issue
|
|
12
|
+
- Removed duplicate CSS rules that were causing filter icon overlap
|
|
13
|
+
- Cleaned up duplicate `.filter-box`, `.filter-icon`, and `.sidebar-breadcrumbs` definitions
|
|
14
|
+
|
|
15
|
+
### Background
|
|
16
|
+
- The removal of style.css in v1.4.5 exposed pre-existing CSS conflicts
|
|
17
|
+
- Duplicate CSS rules were causing the filter icon to render incorrectly
|
|
18
|
+
- Breadcrumb height of 0px (set in v1.3.2) made the breadcrumb bar invisible
|
|
19
|
+
|
|
20
|
+
## [1.4.5] - 2025-07-21
|
|
21
|
+
|
|
22
|
+
### Fixed
|
|
23
|
+
- Removed all references to non-existent style.css file
|
|
24
|
+
- Fixed CSS rendering issues where root page appeared different from other pages
|
|
25
|
+
- Updated CSS existence check in deploy.js to verify notion-style.css instead
|
|
26
|
+
|
|
27
|
+
### Background
|
|
28
|
+
- style.css was removed in v1.4.0 but code references remained
|
|
29
|
+
- This caused 404 errors and potential CSS loading failures
|
|
30
|
+
- All pages now correctly load only notion-style.css as intended
|
|
31
|
+
|
|
8
32
|
## [1.4.4] - 2025-07-21
|
|
9
33
|
|
|
10
34
|
### Added
|
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
|
|
|
@@ -532,40 +532,6 @@ pre code {
|
|
|
532
532
|
margin-bottom: var(--space-4);
|
|
533
533
|
}
|
|
534
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);
|
|
561
|
-
}
|
|
562
|
-
|
|
563
|
-
.filter-icon {
|
|
564
|
-
position: absolute;
|
|
565
|
-
right: var(--space-3);
|
|
566
|
-
color: var(--color-text-tertiary);
|
|
567
|
-
pointer-events: none;
|
|
568
|
-
}
|
|
569
535
|
|
|
570
536
|
/* Navigation */
|
|
571
537
|
.navigation {
|
package/html/README.html
CHANGED
|
@@ -17,7 +17,6 @@
|
|
|
17
17
|
|
|
18
18
|
<!-- Styles -->
|
|
19
19
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
20
|
-
<link rel="stylesheet" href="/css/style.css">
|
|
21
20
|
|
|
22
21
|
<!-- Favicon -->
|
|
23
22
|
<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>">
|
|
@@ -30,7 +29,7 @@
|
|
|
30
29
|
|
|
31
30
|
<div class="header-actions">
|
|
32
31
|
<div class="deployment-info">
|
|
33
|
-
<span class="deployment-date" title="Built with doc-builder v1.4.
|
|
32
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.5">Last updated: Jul 21, 2025, 10:58 AM UTC</span>
|
|
34
33
|
</div>
|
|
35
34
|
|
|
36
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
|
|
|
@@ -532,40 +532,6 @@ pre code {
|
|
|
532
532
|
margin-bottom: var(--space-4);
|
|
533
533
|
}
|
|
534
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);
|
|
561
|
-
}
|
|
562
|
-
|
|
563
|
-
.filter-icon {
|
|
564
|
-
position: absolute;
|
|
565
|
-
right: var(--space-3);
|
|
566
|
-
color: var(--color-text-tertiary);
|
|
567
|
-
pointer-events: none;
|
|
568
|
-
}
|
|
569
535
|
|
|
570
536
|
/* Navigation */
|
|
571
537
|
.navigation {
|
package/html/index.html
CHANGED
|
@@ -17,7 +17,6 @@
|
|
|
17
17
|
|
|
18
18
|
<!-- Styles -->
|
|
19
19
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
20
|
-
<link rel="stylesheet" href="/css/style.css">
|
|
21
20
|
|
|
22
21
|
<!-- Favicon -->
|
|
23
22
|
<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>">
|
|
@@ -30,7 +29,7 @@
|
|
|
30
29
|
|
|
31
30
|
<div class="header-actions">
|
|
32
31
|
<div class="deployment-info">
|
|
33
|
-
<span class="deployment-date" title="Built with doc-builder v1.4.
|
|
32
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.5">Last updated: Jul 21, 2025, 10:58 AM UTC</span>
|
|
34
33
|
</div>
|
|
35
34
|
|
|
36
35
|
|
package/lib/core-builder.js
CHANGED
|
@@ -117,7 +117,6 @@ function generateHTML(title, content, navigation, currentPath = '', config = {})
|
|
|
117
117
|
|
|
118
118
|
<!-- Styles -->
|
|
119
119
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
120
|
-
<link rel="stylesheet" href="/css/style.css">
|
|
121
120
|
|
|
122
121
|
<!-- Favicon -->
|
|
123
122
|
<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>">
|
|
@@ -861,7 +860,6 @@ async function createDefaultIndexPage(outputDir, config, version) {
|
|
|
861
860
|
<title>Welcome to ${siteName}</title>
|
|
862
861
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet">
|
|
863
862
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
864
|
-
<link rel="stylesheet" href="/css/style.css">
|
|
865
863
|
<style>
|
|
866
864
|
.welcome-container {
|
|
867
865
|
max-width: 800px;
|
package/lib/deploy.js
CHANGED
|
@@ -187,7 +187,7 @@ async function deployToVercel(config, isProd = false) {
|
|
|
187
187
|
}
|
|
188
188
|
|
|
189
189
|
// Check if CSS files exist
|
|
190
|
-
const cssPath = path.join(outputPath, 'css', 'style.css');
|
|
190
|
+
const cssPath = path.join(outputPath, 'css', 'notion-style.css');
|
|
191
191
|
if (!fs.existsSync(cssPath)) {
|
|
192
192
|
console.log(chalk.yellow('\nā ļø Warning: CSS files not found in output directory!'));
|
|
193
193
|
console.log(chalk.yellow(' Your documentation may appear without styling.'));
|
|
@@ -433,7 +433,6 @@ async function prepareDeployment(config) {
|
|
|
433
433
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
434
434
|
<meta http-equiv="refresh" content="0; url=${firstFile}">
|
|
435
435
|
<title>${config.siteName || 'Documentation'}</title>
|
|
436
|
-
<link rel="stylesheet" href="/css/style.css">
|
|
437
436
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
438
437
|
</head>
|
|
439
438
|
<body>
|