@knowcode/doc-builder 1.2.7 → 1.2.8
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 +15 -0
- package/README.md +11 -11
- package/assets/css/style.css +1 -1
- package/assets/js/main.js +1 -2
- package/cli.js +2 -2
- package/lib/config.js +8 -8
- package/lib/core-builder.js +8 -8
- package/package.json +3 -3
- package/scripts/setup.js +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,21 @@ 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.2.8] - 2025-07-19
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
- Removed all JUNO references from documentation and code
|
|
12
|
+
- Renamed `cybersolstice` preset to `notion-inspired`
|
|
13
|
+
- Updated folder descriptions to be more generic
|
|
14
|
+
- Changed default username from 'juno' to 'admin' in preset
|
|
15
|
+
- Removed `juno-docs` binary alias from package.json
|
|
16
|
+
- Updated keywords to remove 'juno' and add 'notion-style'
|
|
17
|
+
- Cleaned up all internal references to use @knowcode/doc-builder
|
|
18
|
+
|
|
19
|
+
### Fixed
|
|
20
|
+
- Documentation now correctly references @knowcode/doc-builder instead of @juno/doc-builder
|
|
21
|
+
- Updated GitHub URLs to use knowcode organization
|
|
22
|
+
|
|
8
23
|
## [1.2.7] - 2025-07-19
|
|
9
24
|
|
|
10
25
|
### Added
|
package/README.md
CHANGED
|
@@ -32,12 +32,12 @@ No installation needed! Just run:
|
|
|
32
32
|
|
|
33
33
|
```bash
|
|
34
34
|
# Build and deploy to Vercel (default action)
|
|
35
|
-
npx @
|
|
35
|
+
npx @knowcode/doc-builder
|
|
36
36
|
|
|
37
37
|
# Or use specific commands:
|
|
38
|
-
npx @
|
|
39
|
-
npx @
|
|
40
|
-
npx @
|
|
38
|
+
npx @knowcode/doc-builder build # Build HTML files only
|
|
39
|
+
npx @knowcode/doc-builder dev # Start development server
|
|
40
|
+
npx @knowcode/doc-builder deploy # Deploy to Vercel
|
|
41
41
|
```
|
|
42
42
|
|
|
43
43
|
The default action (no command specified) will build your documentation and deploy it to Vercel.
|
|
@@ -47,7 +47,7 @@ The default action (no command specified) will build your documentation and depl
|
|
|
47
47
|
For faster execution and offline use:
|
|
48
48
|
|
|
49
49
|
```bash
|
|
50
|
-
npm install --save-dev @
|
|
50
|
+
npm install --save-dev @knowcode/doc-builder
|
|
51
51
|
```
|
|
52
52
|
|
|
53
53
|
Then use shorter commands:
|
|
@@ -108,10 +108,10 @@ module.exports = {
|
|
|
108
108
|
|
|
109
109
|
## Presets
|
|
110
110
|
|
|
111
|
-
Use the `
|
|
111
|
+
Use the `notion-inspired` preset for a clean, modern documentation style:
|
|
112
112
|
|
|
113
113
|
```bash
|
|
114
|
-
npx @
|
|
114
|
+
npx @knowcode/doc-builder build --preset notion-inspired
|
|
115
115
|
```
|
|
116
116
|
|
|
117
117
|
## Commands
|
|
@@ -133,7 +133,7 @@ Options:
|
|
|
133
133
|
Examples:
|
|
134
134
|
doc-builder build # Build with defaults
|
|
135
135
|
doc-builder build --input docs --output dist
|
|
136
|
-
doc-builder build --preset
|
|
136
|
+
doc-builder build --preset notion-inspired # Use Notion-inspired preset
|
|
137
137
|
doc-builder build --config my-config.js # Use custom config
|
|
138
138
|
```
|
|
139
139
|
|
|
@@ -218,7 +218,7 @@ While developing the doc-builder:
|
|
|
218
218
|
npm link
|
|
219
219
|
|
|
220
220
|
# In your other project
|
|
221
|
-
npm link @
|
|
221
|
+
npm link @knowcode/doc-builder
|
|
222
222
|
```
|
|
223
223
|
|
|
224
224
|
### Option 2: File Reference
|
|
@@ -228,7 +228,7 @@ In your project's `package.json`:
|
|
|
228
228
|
```json
|
|
229
229
|
{
|
|
230
230
|
"devDependencies": {
|
|
231
|
-
"@
|
|
231
|
+
"@knowcode/doc-builder": "file:../path/to/doc-builder"
|
|
232
232
|
}
|
|
233
233
|
}
|
|
234
234
|
```
|
|
@@ -240,7 +240,7 @@ Once published:
|
|
|
240
240
|
```json
|
|
241
241
|
{
|
|
242
242
|
"devDependencies": {
|
|
243
|
-
"@
|
|
243
|
+
"@knowcode/doc-builder": "git+https://github.com/knowcode/doc-builder.git"
|
|
244
244
|
}
|
|
245
245
|
}
|
|
246
246
|
```
|
package/assets/css/style.css
CHANGED
package/assets/js/main.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Documentation Builder - Main JavaScript
|
|
2
2
|
|
|
3
3
|
// Preview Banner Management
|
|
4
4
|
// Set up banner state immediately to prevent flash
|
|
@@ -1261,7 +1261,6 @@ function generateBreadcrumbs() {
|
|
|
1261
1261
|
.map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
|
|
1262
1262
|
.join(' ')
|
|
1263
1263
|
.replace(/\b(Api|Html|Css|Js|Pdf|Qa|Ai)\b/g, (match) => match.toUpperCase())
|
|
1264
|
-
.replace(/\bJuno\b/g, 'JUNO')
|
|
1265
1264
|
.replace(/\bReadme\b/g, 'Overview');
|
|
1266
1265
|
|
|
1267
1266
|
// Get appropriate icon based on segment
|
package/cli.js
CHANGED
|
@@ -66,7 +66,7 @@ program
|
|
|
66
66
|
.option('-c, --config <path>', 'path to config file (default: doc-builder.config.js)')
|
|
67
67
|
.option('-i, --input <dir>', 'input directory containing markdown files (default: docs)')
|
|
68
68
|
.option('-o, --output <dir>', 'output directory for HTML files (default: html)')
|
|
69
|
-
.option('--preset <preset>', 'use a preset configuration (available:
|
|
69
|
+
.option('--preset <preset>', 'use a preset configuration (available: notion-inspired)')
|
|
70
70
|
.option('--legacy', 'use legacy mode for backward compatibility')
|
|
71
71
|
.option('--no-auth', 'disable authentication even if configured')
|
|
72
72
|
.option('--no-changelog', 'disable automatic changelog generation')
|
|
@@ -74,7 +74,7 @@ program
|
|
|
74
74
|
${chalk.yellow('Examples:')}
|
|
75
75
|
${chalk.gray('$')} doc-builder build ${chalk.gray('# Build with defaults')}
|
|
76
76
|
${chalk.gray('$')} doc-builder build --input docs --output dist
|
|
77
|
-
${chalk.gray('$')} doc-builder build --preset
|
|
77
|
+
${chalk.gray('$')} doc-builder build --preset notion-inspired ${chalk.gray('# Use Notion-inspired preset')}
|
|
78
78
|
${chalk.gray('$')} doc-builder build --config my-config.js ${chalk.gray('# Use custom config')}
|
|
79
79
|
`)
|
|
80
80
|
.action(async (options) => {
|
package/lib/config.js
CHANGED
|
@@ -49,12 +49,12 @@ const defaultConfig = {
|
|
|
49
49
|
};
|
|
50
50
|
|
|
51
51
|
/**
|
|
52
|
-
*
|
|
52
|
+
* Notion-inspired preset - clean, modern documentation style
|
|
53
53
|
*/
|
|
54
|
-
const
|
|
54
|
+
const notionInspiredPreset = {
|
|
55
55
|
docsDir: 'docs',
|
|
56
56
|
outputDir: 'html',
|
|
57
|
-
siteName: '
|
|
57
|
+
siteName: 'Documentation', // Clean default name
|
|
58
58
|
siteDescription: 'Transforming complex sales through intelligent automation',
|
|
59
59
|
|
|
60
60
|
features: {
|
|
@@ -67,7 +67,7 @@ const cybersolsticePreset = {
|
|
|
67
67
|
},
|
|
68
68
|
|
|
69
69
|
auth: {
|
|
70
|
-
username: '
|
|
70
|
+
username: 'admin',
|
|
71
71
|
password: 'docs2025'
|
|
72
72
|
},
|
|
73
73
|
|
|
@@ -78,7 +78,7 @@ const cybersolsticePreset = {
|
|
|
78
78
|
|
|
79
79
|
// Folder descriptions from existing code
|
|
80
80
|
folderDescriptions: {
|
|
81
|
-
'product-roadmap': 'Strategic vision, timeline, and feature planning
|
|
81
|
+
'product-roadmap': 'Strategic vision, timeline, and feature planning',
|
|
82
82
|
'product-requirements': 'Detailed product specifications, requirements documents, and feature definitions',
|
|
83
83
|
'architecture': 'System design, data flows, and technical infrastructure documentation',
|
|
84
84
|
'system-analysis': 'Comprehensive system analysis, functional requirements, and cross-component documentation',
|
|
@@ -143,8 +143,8 @@ async function loadConfig(configPath, options = {}) {
|
|
|
143
143
|
let config = { ...defaultConfig };
|
|
144
144
|
|
|
145
145
|
// Apply preset if specified
|
|
146
|
-
if (options.preset === '
|
|
147
|
-
config = { ...config, ...
|
|
146
|
+
if (options.preset === 'notion-inspired') {
|
|
147
|
+
config = { ...config, ...notionInspiredPreset };
|
|
148
148
|
}
|
|
149
149
|
|
|
150
150
|
// Load custom config file if it exists
|
|
@@ -251,7 +251,7 @@ async function createDefaultConfig() {
|
|
|
251
251
|
|
|
252
252
|
module.exports = {
|
|
253
253
|
defaultConfig,
|
|
254
|
-
|
|
254
|
+
notionInspiredPreset,
|
|
255
255
|
loadConfig,
|
|
256
256
|
createDefaultConfig
|
|
257
257
|
};
|
package/lib/core-builder.js
CHANGED
|
@@ -179,8 +179,8 @@ const folderDescriptions = {
|
|
|
179
179
|
'bubble': 'Core application platform - business logic, UI/UX, and user workflows',
|
|
180
180
|
'quickbase': 'Database schema, data management, and backend operations',
|
|
181
181
|
'activecampaign': 'Marketing automation integration and lead management system',
|
|
182
|
-
'
|
|
183
|
-
'
|
|
182
|
+
'doc-signer': 'Document signing service for digital signatures and PDF generation',
|
|
183
|
+
'api-deprecated': 'Legacy API documentation (deprecated, for reference only)',
|
|
184
184
|
'postman': 'API testing tools, collections, and test automation',
|
|
185
185
|
'mcp': 'Model Context Protocol integration and configuration',
|
|
186
186
|
'team': 'Team structure, roles, and responsibilities',
|
|
@@ -188,7 +188,7 @@ const folderDescriptions = {
|
|
|
188
188
|
'middleware': 'Integration layers and data transformation services',
|
|
189
189
|
'paths': 'User journey flows and process workflows',
|
|
190
190
|
'testing': 'Test strategies, scenarios, and quality assurance processes',
|
|
191
|
-
'
|
|
191
|
+
'api': 'API documentation and integration guides'
|
|
192
192
|
};
|
|
193
193
|
|
|
194
194
|
// Build navigation structure with rich functionality
|
|
@@ -250,8 +250,8 @@ function buildNavigationStructure(files, currentFile) {
|
|
|
250
250
|
'bubble': 'fas fa-circle',
|
|
251
251
|
'quickbase': 'fas fa-database',
|
|
252
252
|
'activecampaign': 'fas fa-envelope',
|
|
253
|
-
'
|
|
254
|
-
'
|
|
253
|
+
'doc-signer': 'fas fa-signature',
|
|
254
|
+
'api-deprecated': 'fas fa-archive',
|
|
255
255
|
'postman': 'fas fa-flask',
|
|
256
256
|
'mcp': 'fas fa-puzzle-piece',
|
|
257
257
|
'team': 'fas fa-users',
|
|
@@ -259,7 +259,7 @@ function buildNavigationStructure(files, currentFile) {
|
|
|
259
259
|
'middleware': 'fas fa-layer-group',
|
|
260
260
|
'paths': 'fas fa-route',
|
|
261
261
|
'testing': 'fas fa-vial',
|
|
262
|
-
'
|
|
262
|
+
'api': 'fas fa-plug',
|
|
263
263
|
'documentation-tool': 'fas fa-tools'
|
|
264
264
|
};
|
|
265
265
|
|
|
@@ -358,8 +358,8 @@ function buildNavigationStructure(files, currentFile) {
|
|
|
358
358
|
'bubble',
|
|
359
359
|
'quickbase',
|
|
360
360
|
'activecampaign',
|
|
361
|
-
'
|
|
362
|
-
'
|
|
361
|
+
'doc-signer',
|
|
362
|
+
'api-deprecated',
|
|
363
363
|
'postman',
|
|
364
364
|
'mcp',
|
|
365
365
|
'team',
|
package/package.json
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@knowcode/doc-builder",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.8",
|
|
4
4
|
"description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"bin": {
|
|
7
7
|
"doc-builder": "./cli.js",
|
|
8
|
-
"juno-docs": "./cli.js",
|
|
9
8
|
"@knowcode/doc-builder": "./scripts/npx-runner.js"
|
|
10
9
|
},
|
|
11
10
|
"scripts": {
|
|
@@ -17,7 +16,8 @@
|
|
|
17
16
|
"markdown",
|
|
18
17
|
"static-site-generator",
|
|
19
18
|
"vercel",
|
|
20
|
-
"
|
|
19
|
+
"notion-style",
|
|
20
|
+
"doc-builder"
|
|
21
21
|
],
|
|
22
22
|
"author": "KnowCode",
|
|
23
23
|
"license": "MIT",
|
package/scripts/setup.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Post-install setup script for @
|
|
2
|
+
* Post-install setup script for @knowcode/doc-builder
|
|
3
3
|
* This script runs after npm install to help users get started
|
|
4
4
|
*/
|
|
5
5
|
|
|
@@ -52,5 +52,5 @@ if (foundDir) {
|
|
|
52
52
|
console.log(chalk.yellow(`ℹ️ No docs directory found. Create a 'docs' folder with markdown files to get started.\n`));
|
|
53
53
|
}
|
|
54
54
|
|
|
55
|
-
console.log(chalk.gray('For more information, visit: https://github.com/
|
|
55
|
+
console.log(chalk.gray('For more information, visit: https://github.com/knowcode/doc-builder'));
|
|
56
56
|
console.log(chalk.gray('To create a config file, run: doc-builder init --config\n'));
|