@knowcode/doc-builder 1.9.30 → 1.9.31

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowcode/doc-builder",
-  "version": "1.9.30",
+  "version": "1.9.31",
   "description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
   "main": "index.js",
   "bin": {
@@ -29,7 +29,6 @@
   },
   "homepage": "https://github.com/wapdat/doc-builder#readme",
   "dependencies": {
-    "@knowcode/doc-builder": "^1.4.21",
     "@supabase/supabase-js": "^2.39.0",
     "chalk": "^4.1.2",
     "commander": "^11.0.0",
@@ -40,6 +39,17 @@
     "prompts": "^2.4.2",
     "semver": "^7.7.2"
   },
+  "files": [
+    "cli.js",
+    "index.js",
+    "lib/**/*",
+    "assets/**/*",
+    "scripts/**/*",
+    "templates/**/*",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
   "engines": {
     "node": ">=14.0.0"
   }

package/.claude/settings.local.json

@@ -1,56 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(node:*)",
-      "Bash(git add:*)",
-      "Bash(git commit:*)",
-      "Bash(npm version:*)",
-      "Bash(npm pack)",
-      "Bash(cat:*)",
-      "Bash(rm:*)",
-      "Bash(npm publish:*)",
-      "Bash(git tag:*)",
-      "Bash(git push:*)",
-      "Bash(git pull:*)",
-      "Bash(git rebase:*)",
-      "Bash(npm info:*)",
-      "Bash(npx:*)",
-      "Bash(grep:*)",
-      "Bash(npm cache clean:*)",
-      "Bash(ls:*)",
-      "Bash(npm run build:*)",
-      "Bash(npm view:*)",
-      "Bash(npm:*)",
-      "Bash(vercel project:*)",
-      "Bash(vercel alias:*)",
-      "Bash(find:*)",
-      "Bash(diff:*)",
-      "Bash(git log:*)",
-      "Bash(mkdir:*)",
-      "Bash(cp:*)",
-      "Bash(./publish.sh)",
-      "Bash(mv:*)",
-      "WebFetch(domain:convert-to-markdown.vercel.app)",
-      "Bash(pkill:*)",
-      "Bash(curl:*)",
-      "Bash(./cli.js build:*)",
-      "Bash(./cli.js deploy:*)",
-      "Bash(./add-users.sh:*)",
-      "Bash(python3:*)",
-      "Bash(chmod:*)",
-      "Bash(supabase auth:*)",
-      "Bash(supabase:*)",
-      "Bash(DEBUG=1 ./user-management/add-users.sh add wru-bid-analysis.vercel.app lindsay@knowcode.tech)",
-      "Bash(./user-management/add-users.sh:*)",
-      "Bash(DEBUG=1 ./add-users.sh add wru-bid-analysis.vercel.app lindsay@knowcode.tech)",
-      "Bash(brew upgrade:*)",
-      "Bash(psql:*)",
-      "Bash(open /Users/lindsaysmith/Documents/lambda1.nosync/doc-builder/html/image-modal-test.html)",
-      "WebFetch(domain:nudge-campaign.vercel.app)",
-      "WebFetch(domain:mermaid.js.org)",
-      "Bash(open html/test-mermaid-enhanced.html)",
-      "Bash(open:*)"
-    ],
-    "deny": []
-  }
-}

package/CACHE-BUSTING-GUIDE.md

@@ -1,82 +0,0 @@
-# Cache Busting Guide for @knowcode/doc-builder
-
-If you're not seeing updates after upgrading to a new version, it's likely due to caching. Follow these steps:
-
-## 1. Clean Everything Locally
-
-```bash
-# Remove old build artifacts
-rm -rf html/
-
-# Clear npm cache
-npm cache clean --force
-
-# Remove node_modules and reinstall
-rm -rf node_modules
-npm install
-
-# Make sure you have the latest version
-npm install @knowcode/doc-builder@latest
-```
-
-## 2. Rebuild with Fresh Files
-
-```bash
-# Build fresh documentation
-npx @knowcode/doc-builder build
-```
-
-## 3. Deploy with Force Flag
-
-```bash
-# Force Vercel to ignore cache
-vercel --prod --force
-```
-
-## 4. Clear Browser Cache
-
-- **Chrome/Edge**: Cmd+Shift+R (Mac) or Ctrl+Shift+R (Windows)
-- **Firefox**: Cmd+Shift+R (Mac) or Ctrl+Shift+R (Windows)
-- **Safari**: Cmd+Option+R
-- Or use Incognito/Private browsing mode
-
-## 5. Clear Vercel/CDN Cache (if applicable)
-
-If using Vercel:
-1. Go to your project dashboard
-2. Settings → Functions → Purge Cache
-3. Or redeploy with a different domain temporarily
-
-## 6. Add Cache Busting to Your Build
-
-Edit your `doc-builder.config.js` to add version query strings:
-
-```javascript
-module.exports = {
-  // ... other config
-  cacheBust: true, // This will add ?v=timestamp to CSS/JS files
-};
-```
-
-## Common Issues
-
-- **"I updated but nothing changed"** - It's cache. Follow all steps above.
-- **"Tooltips still don't work"** - Clear browser cache and check console for errors
-- **"Spacing is still wrong"** - The CSS is cached. Hard refresh the page.
-
-## Verify You Have The Right Version
-
-Check the version in your package.json:
-```bash
-npm list @knowcode/doc-builder
-```
-
-Should show: `@knowcode/doc-builder@1.3.13` or higher.
-
-## Still Not Working?
-
-1. Open browser DevTools
-2. Go to Network tab
-3. Check "Disable cache" checkbox
-4. Refresh the page
-5. Look at the CSS/JS files being loaded - they should not show "(from cache)"

package/CLAUDE.md

@@ -1,86 +0,0 @@
-# CLAUDE.md - @knowcode/doc-builder
-
-This file provides comprehensive guidance for Claude Code when working with the @knowcode/doc-builder project - a Notion-inspired documentation generator that converts markdown files to beautiful static HTML sites with Vercel deployment support.
-
-## Project Overview
-
-**Name**: @knowcode/doc-builder  
-**Version**: 1.4.3  
-**Purpose**: Transform markdown documentation into beautiful, searchable static HTML sites with a Notion-inspired design  
-**NPM Package**: Published at https://www.npmjs.com/package/@knowcode/doc-builder
-**GitHub Repository**: https://github.com/wapdat/doc-builder
-
-### Key Features
-- 📝 **Markdown to HTML conversion** with syntax highlighting and mermaid diagram support
-- 🎨 **Notion-inspired design** with dark mode support
-- 🚀 **One-command Vercel deployment** with zero configuration
-- 🔍 **Auto-generated navigation** from folder structure
-- 🔐 **Optional authentication** for private documentation
-- 📊 **Mermaid diagram support** out of the box
-- 📱 **Fully responsive** design
-- 🔧 **Zero configuration** - works with sensible defaults
-
-## Emoji to Icon Mapping
-
-The project includes automatic emoji to Phosphor icon conversion in markdown files. To add new emoji mappings:
-
-### Adding New Emoji Mappings
-
-1. **Location**: Edit `lib/emoji-mapper.js`
-2. **Structure**: Add entries to the `emojiToPhosphor` object
-3. **Format**: `'🏷️': '<i class="ph ph-tag" aria-label="tag"></i>'`
-
-### Guidelines for New Mappings
-
-- **Categorization**: Place emojis in appropriate sections (UI & Design, Actions & Navigation, etc.)
-- **Icon Selection**: Use appropriate Phosphor icons from https://phosphoricons.com
-- **Aria Labels**: Include descriptive aria-label attributes for accessibility
-- **Semantic Matching**: Choose icons that best represent the emoji's meaning
-
-### Example Addition
-
-```javascript
-// In the UI & Design section
-'🏷️': '<i class="ph ph-tag" aria-label="tag"></i>',
-'👁️': '<i class="ph ph-eye" aria-label="view"></i>',
-```
-
-### Available Phosphor Icon Weights
-
-The system supports different icon weights via configuration:
-- `regular` (default)
-- `thin`
-- `light` 
-- `bold`
-- `fill`
-- `duotone`
-
-## Documentation Guidelines
-
-- For this project documentation, do not include in each document:
-  - Generated timestamp
-  - Status field
-  - Verification status
-- We do not want these metadata fields in the project documentation
-
-## NPM Publishing
-
-### Easy Publishing Workflow
-
-The simple way to publish to npm:
-
-1. **Update version** in `package.json`
-2. **Commit changes**: `git add . && git commit -m "feat: description"`
-3. **Publish**: `npm publish`
-
-### Prerequisites
-
-- Logged into npm: `npm whoami` 
-- Version not already published
-- Working directory clean
-
-### Notes
-
-- Use `npm publish` directly instead of the interactive script
-- No need for complex automation - npm handles everything
-- Package automatically includes all necessary files via package.json

package/CONTRIBUTING.md

@@ -1,148 +0,0 @@
-# Contributing to Doc Builder
-
-First off, thank you for considering contributing to Doc Builder! It's people like you that make Doc Builder such a great tool.
-
-## Code of Conduct
-
-By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
-
-## How Can I Contribute?
-
-### Reporting Bugs
-
-Before creating bug reports, please check existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:
-
-* **Use a clear and descriptive title**
-* **Describe the exact steps to reproduce the problem**
-* **Provide specific examples to demonstrate the steps**
-* **Describe the behavior you observed and expected**
-* **Include screenshots if relevant**
-* **Include your environment details** (OS, Node.js version, npm version)
-
-### Suggesting Enhancements
-
-Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:
-
-* **Use a clear and descriptive title**
-* **Provide a detailed description of the suggested enhancement**
-* **Provide specific examples to demonstrate how it would work**
-* **Describe the current behavior and expected behavior**
-* **Explain why this enhancement would be useful**
-
-### Your First Code Contribution
-
-Unsure where to begin? You can start by looking through these issues:
-
-* `good first issue` - issues which should only require a few lines of code
-* `help wanted` - issues which need extra attention
-
-### Pull Requests
-
-1. Fork the repo and create your branch from `main`
-2. If you've added code that should be tested, add tests
-3. If you've changed APIs, update the documentation
-4. Ensure the test suite passes
-5. Make sure your code follows the existing style
-6. Issue that pull request!
-
-## Development Process
-
-1. **Setup your environment**
-   ```bash
-   git clone https://github.com/YOUR_USERNAME/doc-builder.git
-   cd doc-builder
-   npm install
-   ```
-
-2. **Create a branch**
-   ```bash
-   git checkout -b feature/your-feature-name
-   ```
-
-3. **Make your changes**
-   - Write code
-   - Add tests if applicable
-   - Update documentation
-
-4. **Test your changes**
-   ```bash
-   npm test
-   npm run build
-   npm run dev
-   ```
-
-5. **Commit your changes**
-   ```bash
-   git add .
-   git commit -m "feat: add amazing feature"
-   ```
-
-   We follow [Conventional Commits](https://www.conventionalcommits.org/):
-   - `feat:` new feature
-   - `fix:` bug fix
-   - `docs:` documentation changes
-   - `style:` formatting, missing semicolons, etc
-   - `refactor:` code change that neither fixes a bug nor adds a feature
-   - `test:` adding missing tests
-   - `chore:` maintain
-
-6. **Push to your fork**
-   ```bash
-   git push origin feature/your-feature-name
-   ```
-
-7. **Open a Pull Request**
-
-## Style Guide
-
-### JavaScript Style Guide
-
-* Use ES6+ features where appropriate
-* 2 spaces for indentation
-* Use semicolons
-* Use `const` and `let`, avoid `var`
-* Use meaningful variable names
-* Add comments for complex logic
-
-### Documentation Style Guide
-
-* Use Markdown for all documentation
-* Include code examples where relevant
-* Keep line length to 80 characters where possible
-* Use present tense ("Add feature" not "Added feature")
-
-## Testing
-
-* Write tests for new features
-* Ensure all tests pass before submitting PR
-* Aim for high code coverage
-* Test edge cases
-
-## Project Structure
-
-```
-doc-builder/
-├── assets/          # Static assets
-├── lib/             # Core library code
-├── scripts/         # Build and utility scripts
-├── templates/       # HTML templates
-├── test/           # Test files
-├── docs/           # Documentation
-└── cli.js          # CLI entry point
-```
-
-## Release Process
-
-Maintainers will handle releases, but for reference:
-
-1. Update version in `package.json`
-2. Update `CHANGELOG.md`
-3. Commit changes
-4. Tag release
-5. Push to npm
-
-## Questions?
-
-Feel free to open an issue with your question or reach out to the maintainers.
-
-Thank you for contributing! 🎉

package/GITHUB_SETUP.md

@@ -1,203 +0,0 @@
-# GitHub Repository Setup Instructions
-
-This guide will walk you through setting up the doc-builder project on GitHub.
-
-## Prerequisites
-
-- GitHub account
-- Git installed locally
-- Command line access
-
-## Step 1: Create GitHub Repository
-
-1. Go to https://github.com/new
-2. Repository settings:
-   - **Repository name**: `doc-builder`
-   - **Description**: `Transform markdown into beautiful documentation sites with one-command Vercel deployment`
-   - **Public** repository (for open source)
-   - **DO NOT** initialize with README, .gitignore, or license (we already have these)
-
-3. Click "Create repository"
-
-## Step 2: Update Local Git Configuration
-
-First, let's check the current remote:
-
-```bash
-git remote -v
-```
-
-You'll see it points to a local directory. We need to change this to GitHub.
-
-## Step 3: Add GitHub as Remote
-
-Since your repository is at https://github.com/wapdat/doc-builder:
-
-```bash
-# Remove the existing remote
-git remote remove origin
-
-# Add GitHub as the new origin
-git remote add origin https://github.com/wapdat/doc-builder.git
-
-# Verify the change
-git remote -v
-```
-
-## Step 4: Push to GitHub
-
-```bash
-# Push all branches and tags
-git push -u origin main
-git push --tags
-```
-
-## Step 5: Configure Repository Settings
-
-On GitHub, go to Settings and configure:
-
-### General Settings
-- **Features**: Enable Issues, Projects, and Discussions
-- **Pull Requests**: Allow merge commits, squash merging, and rebase merging
-
-### Branch Protection (Settings → Branches)
-For the `main` branch:
-- [ ] Require pull request reviews before merging
-- [ ] Dismiss stale pull request approvals
-- [ ] Require status checks to pass
-- [ ] Include administrators
-
-### Pages (optional, for documentation)
-- Source: Deploy from a branch
-- Branch: main
-- Folder: /docs
-
-### Topics
-Add these topics to help people discover your project:
-- `documentation`
-- `markdown`
-- `static-site-generator`
-- `vercel`
-- `notion`
-- `developer-tools`
-- `nodejs`
-- `npm-package`
-
-## Step 6: Add Badges to README
-
-Update your README.md to include GitHub badges:
-
-```markdown
-[![npm version](https://img.shields.io/npm/v/@knowcode/doc-builder)](https://www.npmjs.com/package/@knowcode/doc-builder)
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
-[![GitHub stars](https://img.shields.io/github/stars/wapdat/doc-builder)](https://github.com/wapdat/doc-builder/stargazers)
-[![GitHub issues](https://img.shields.io/github/issues/wapdat/doc-builder)](https://github.com/wapdat/doc-builder/issues)
-```
-
-## Step 7: Create Initial Release
-
-1. Go to https://github.com/wapdat/doc-builder/releases
-2. Click "Create a new release"
-3. Tag version: `v1.5.21`
-4. Release title: `v1.5.21 - Stable Release`
-5. Description:
-   ```markdown
-   ## Doc Builder v1.5.21
-   
-   First public release of Doc Builder on GitHub!
-   
-   ### Features
-   - ✨ Notion-inspired design
-   - 🚀 One-command Vercel deployment
-   - 🔍 Built-in search functionality
-   - 🌓 Dark mode support
-   - 📊 Mermaid diagram integration
-   - 🔐 Password protection option
-   
-   ### Installation
-   ```bash
-   npm install -g @knowcode/doc-builder
-   ```
-   
-   ### Quick Start
-   ```bash
-   npx @knowcode/doc-builder@latest deploy
-   ```
-   ```
-6. Click "Publish release"
-
-## Step 8: Set Up GitHub Actions (Optional)
-
-Create `.github/workflows/npm-publish.yml`:
-
-```yaml
-name: Publish to NPM
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-          registry-url: 'https://registry.npmjs.org'
-      - run: npm ci
-      - run: npm test
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
-```
-
-To use this:
-1. Get npm token from https://www.npmjs.com/settings/YOUR_NPM_USERNAME/tokens
-2. Add as secret in GitHub: Settings → Secrets → Actions → New repository secret
-3. Name: `NPM_TOKEN`
-
-## Step 9: Update Package.json
-
-Add GitHub repository info to package.json:
-
-```json
-"repository": {
-  "type": "git",
-  "url": "git+https://github.com/wapdat/doc-builder.git"
-},
-"bugs": {
-  "url": "https://github.com/wapdat/doc-builder/issues"
-},
-"homepage": "https://github.com/wapdat/doc-builder#readme"
-```
-
-## Step 10: Announce the Repository
-
-Once everything is set up:
-
-1. Update the demo site to link to GitHub
-2. Update npm package to include repository link
-3. Share on social media
-4. Submit to awesome lists
-5. Post in relevant communities
-
-## Maintenance Tips
-
-- Respond to issues promptly
-- Review pull requests within a week
-- Keep dependencies updated
-- Tag releases consistently
-- Maintain a clear roadmap
-- Acknowledge contributors
-
-## Next Steps
-
-1. [ ] Create a GitHub Project board for roadmap
-2. [ ] Set up GitHub Discussions for community
-3. [ ] Add GitHub Sponsors if desired
-4. [ ] Create GitHub Wiki for extended docs
-5. [ ] Set up automated testing with GitHub Actions
-
-The repository is configured for https://github.com/wapdat/doc-builder

package/RELEASE-NOTES-1.7.5.md

@@ -1,64 +0,0 @@
-# Release Notes - v1.7.5
-
-## 🎉 Major Change: Authentication is Now Optional by Default!
-
-Starting with v1.7.5, @knowcode/doc-builder defaults to creating **public documentation sites** without authentication. This aligns with the most common use case and makes it even easier to get started.
-
-### What's New
-
-#### 🔓 No Authentication by Default
-- Documentation sites are now public by default
-- No configuration needed for public docs
-- Authentication must be explicitly enabled when needed
-
-#### 🚀 New CLI Flags
-- `--no-auth` flag for both build and deploy commands
-- Override any authentication settings in your config
-- Perfect for quick public deployments
-
-### Examples
-
-```bash
-# Deploy public documentation (default behavior)
-npx @knowcode/doc-builder deploy
-
-# Force public deployment even if config has auth
-npx @knowcode/doc-builder deploy --no-auth
-
-# Enable authentication in config
-# doc-builder.config.js
-module.exports = {
-  features: {
-    authentication: 'supabase'  // Explicitly enable
-  }
-};
-```
-
-### Migration Guide
-
-#### If you want PUBLIC documentation:
-No changes needed! Your sites are now public by default.
-
-#### If you want PRIVATE documentation:
-Add this to your config:
-```javascript
-features: {
-  authentication: 'supabase'
-}
-```
-
-### Why This Change?
-
-- Most documentation should be publicly accessible
-- Reduces friction for new users
-- Makes the tool more intuitive
-- Authentication becomes an intentional choice
-
-### Full Changelog
-
-- **Changed**: Authentication disabled by default in all configurations
-- **Added**: `--no-auth` flags for build and deploy commands
-- **Improved**: Simplified configuration prompts
-- **Docs**: Added public site deployment guide
-
-This is a breaking change, but one that makes the tool simpler and more aligned with common use cases.