@knowcode/doc-builder 1.1.0 → 1.1.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.
Files changed (3) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/cli.js +11 -4
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -5,6 +5,19 @@ 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.1.1] - 2025-01-19
9
+
10
+ ### Added
11
+ - TL;DR section at the top of CLI help for quick understanding
12
+ - Clear production deployment behavior explanation in help
13
+ - Visual indicators for v1.1.0+ deployment changes
14
+ - Examples showing production URLs vs preview URLs
15
+
16
+ ### Improved
17
+ - Help text now prominently shows default production deployment
18
+ - Added emoji and color highlights for important changes
19
+ - Clearer deployment behavior section
20
+
8
21
  ## [1.1.0] - 2025-01-19
9
22
 
10
23
  ### Changed (BREAKING)
package/cli.js CHANGED
@@ -27,11 +27,16 @@ program
27
27
  .addHelpText('before', `
28
28
  ${chalk.cyan('🚀 @knowcode/doc-builder')} - Transform your markdown into beautiful documentation sites
29
29
 
30
+ ${chalk.bgGreen.black(' TL;DR ')} ${chalk.green('Just run:')} ${chalk.cyan.bold('npx @knowcode/doc-builder')} ${chalk.green('→ Your docs are live on Vercel!')}
31
+
32
+ ${chalk.gray('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━')}
33
+
30
34
  ${chalk.yellow('What it does:')}
31
35
  • Converts markdown files to static HTML with a beautiful Notion-inspired theme
32
36
  • Automatically generates navigation from your folder structure
33
37
  • Supports mermaid diagrams, syntax highlighting, and dark mode
34
38
  • Deploys to Vercel with one command (zero configuration)
39
+ • ${chalk.green.bold('NEW:')} Deploys directly to production by default (v1.1.0+)
35
40
  • Optional authentication to protect private documentation
36
41
 
37
42
  ${chalk.yellow('Requirements:')}
@@ -183,10 +188,12 @@ ${chalk.yellow('First-time Vercel Setup:')}
183
188
  • Under "Deployment Protection", set to ${chalk.yellow('Disabled')}
184
189
  • This allows public access to your docs
185
190
 
186
- ${chalk.yellow('Subsequent Deployments:')}
187
- ${chalk.gray('$')} npx @knowcode/doc-builder ${chalk.gray('# Build and deploy to production')}
188
- ${chalk.gray('$')} npx @knowcode/doc-builder deploy ${chalk.gray('# Deploy to production')}
189
- ${chalk.gray('$')} npx @knowcode/doc-builder deploy --no-prod ${chalk.gray('# Deploy preview only')}
191
+ ${chalk.yellow('Deployment Behavior (v1.1.0+):')}
192
+ ${chalk.green.bold('🎯 DEFAULT: All deployments go to PRODUCTION')}
193
+
194
+ ${chalk.gray('$')} npx @knowcode/doc-builder ${chalk.gray('# yourdocs.vercel.app')}
195
+ ${chalk.gray('$')} npx @knowcode/doc-builder deploy ${chalk.gray('# → yourdocs.vercel.app')}
196
+ ${chalk.gray('$')} npx @knowcode/doc-builder deploy --no-prod ${chalk.gray('# → preview URL only')}
190
197
 
191
198
  ${chalk.yellow('When All Else Fails - Delete and Start Fresh:')}
192
199
  Sometimes the cleanest solution is to delete the Vercel project:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowcode/doc-builder",
3
- "version": "1.1.0",
3
+ "version": "1.1.1",
4
4
  "description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
5
5
  "main": "index.js",
6
6
  "bin": {