v1.2.1 - Bug Fixes and Enhanced Testing

Fixed

• Alpine.js syntax error in mobile navigation - Fixed malformed :class binding
  • Corrected invalid syntax to proper ternary operator: mobileMenuOpen ? 'flex' : 'hidden sm:flex'
  • Added tailwhip skip_expressions configuration to prevent formatting ternary operators
  • Changed Playwright reporter to 'list' to prevent background server processes

Added

• Comprehensive Playwright tests for burger menu - Added 4 new tests for mobile navigation
  • Desktop: burger hidden, navigation visible by default
  • Mobile: burger button visible
  • Mobile: menu toggles on/off with burger clicks
  • Mobile: menu closes after section selection, active state persists
  • All tests verify correct element visibility and state management across viewport sizes

Installation

# Using uv (recommended)
uvx microdocs@1.2.1 README.md CHANGELOG.md

# Using pip
pip install --upgrade microdocs

v1.2.0 - Mobile Navigation & Template Improvements

Version 1.2.0 (2025-11-23)

Added

• Custom footer text - New --footer / -f CLI option
  • Allows setting custom footer text instead of automatic build timestamp
  • Example: microdocs README.md --footer "v1.1 2025-01-01"
  • Falls back to timestamp if not provided
• Mobile Navigation - Added responsive burger menu for mobile devices
  • Collapsible navigation menu for screens smaller than 640px
  • Smooth transition animations for menu toggle
  • Includes action buttons (theme toggle, repo link) in mobile view
  • Maintains clean row layout for desktop view
• Repository Icons - Added specific icons for GitHub, GitLab, and Bitbucket
  • Automatically detects repository provider from URL
  • Falls back to generic code icon for other providers
  • Uses high-quality SVG icons from Simple Icons
• TOC Styling - Refactored Table of Contents CSS
  • Uses CSS variables for indentation (--toc-indent-step)
  • Simplifies nested list styling with calc()
• Playwright testing infrastructure for end-to-end template testing
  • playwright/build-test-template.js - Script to build and test templates with real content
  • playwright/fixtures/ - Sample markdown files for testing
  • playwright/playwright.config.js - Playwright configuration
  • Playwright dependencies added to package.json
  • Test results directories added to .gitignore
• Vite configuration (vite.config.js)
  • Auto-discovers template directories
  • Configures single-file builds with viteSingleFile plugin
  • Removes module attributes from inlined scripts
  • Minifies output with Terser
• Package build configuration - Excluded development files from PyPI distribution
  • Excludes: playwright/, templates_src/, node_modules/, config files
• Image Row Detection - Automatically detects and styles paragraphs containing only linked images
  • Applies .image-row class to paragraphs containing only linked images or SVGs
  • Supports multiple images per link (e.g. for complex badges)
  • Ensures proper alignment and spacing for badge rows

Changed

• Template typography - Updated default template fonts
  • Sans-serif: Inter (modern, highly readable)
  • Heading: Zilla Slab (bold, friendly slab serif)
  • Monospace: IBM Plex Mono (professional code font)
  • Improved heading borders and link hover states
  • Enhanced code block styling with better contrast
• Template configuration - Simplified JavaScript initialization
  • Removed JSON config script tag entirely
  • JavaScript now reads section IDs directly from navigation DOM using data-section-id attributes
  • Consolidated mobile and desktop navigation into single responsive component
  • Removed duplicate id="mobile-nav" - now uses single id="main-nav" that adapts
  • Reduced HTML payload by ~3KB and eliminated code duplication
• Markdown rendering improvements - Enhanced markdown processing with GitHub-flavored features
  • Added mdx-truly-sane-lists extension for proper nested list rendering with 2-space indentation
  • Lists now render with correct <ul> nesting instead of flattening all items into a single list
  • Fixes CHANGELOG-style formatting where sub-items appear under bold parent items
  • Added pymdown-extensions for GitHub-flavored markdown support:
    • Auto-linking URLs without explicit markdown syntax
    • Strikethrough text with ~~text~~
    • Task lists with - [ ] and - [x] checkboxes
    • Emoji support with :emoji: shortcodes
    • Better code fences and emphasis handling
• Dark mode styling improvements - Refactored template styling for better dark mode support
  • Replaced custom --color-doc-* CSS variables with Tailwind's standard color system
  • Now using dark:prose-invert for automatic dark mode typography from @tailwindcss/typography
  • Simplified CSS by ~70 lines while maintaining full dark mode compatibility
  • Fixed blockquotes and table headers appearing too dark in dark mode
  • All colors now use explicit dark: variants (e.g., text-gray-900 dark:text-gray-100)
  • Code block backgrounds improved: bg-gray-50 dark:bg-gray-800
• Template build system - Complete redesign using Vite
  • Templates are now built from source files in templates_src/ to single-file outputs in microdocs/templates/
  • Vite automatically discovers and builds all template directories
  • CSS (Tailwind) and JavaScript are inlined into single HTML files
  • Development server with hot-reloading: npm run dev
  • Production builds: npm run build
  • Preview built templates: npm run preview
  • Source files (templates_src/) excluded from PyPI package distribution
• Template CLI - Enhanced template selection
  • --template now accepts both template names (e.g., default) and file paths
  • Template names automatically resolve to built-in templates
  • Available templates listed in help text
  • Example: microdocs README.md -t default or microdocs README.md -t /path/to/custom.html
• Template structure - Reorganized for better maintainability
  • Source: templates_src/{name}/{name}.html, {name}.css, {name}.js
  • Output: microdocs/templates/{name}/{name}.html (single file)
  • Removed legacy CSS file inlining (inlined_css template variable removed)
  • Builder no longer looks for companion .css files
• Pre-commit hooks - Removed djhtml hook (Django template formatter) as it's no longer needed
• Documentation - Comprehensive template development guide
  • New templates_src/TEMPLATES.md with complete guide for creating custom templates
  • Updated CLAUDE.md with Vite workflow instructions
  • Updated README.md with simplified template usage section

Fixed

• TOC deep linking across sections - Fixed table of contents links navigating to wrong section
  • Heading IDs are now prefixed with section name (e.g., readme-deep-dive, guide-deep-dive)
  • Prevents TOC links from jumping to identically-named headings in other sections
  • Added custom slugify function to markdown toc extension for ID prefixing
  • Added Playwright test to verify TOC navigation stays within correct section
• Sticky header overlap - Fixed headings appearing under sticky navigation when scrolling via TOC
  • Added scroll-padding-top: 86px to CSS for proper anchor positioning
  • Added scroll-behavior: smooth for smooth scrolling
  • Configured Tocbot with headingsOffset: 86 for accurate scroll spy detection
  • Set scrollSmooth: false to let browser handle native scrolling behavior
• Header title navigation - Clicking the documentation title now returns to first section and scrolls to top
  • Uses Alpine.js to set active section and scroll to page top
  • Provides intuitive way to return to beginning of documentation

Removed

• Template tests - Removed microdocs/tests/test_templates.py
  • 16 tests for template variable presence and CSS inlining removed
  • Template testing now handled by Playwright for more realistic E2E testing
• Legacy template file - Removed microdocs/templates/default.css
  • CSS now inlined during Vite build process

Installation

# Using uv (recommended)
uvx microdocs@1.2 README.md CHANGELOG.md

# Using pip
pip install --upgrade microdocs

🚀 Generated with Claude Code

v1.1.0 - Internal Link Rewriting

Added

• Internal link rewriting - Automatically converts markdown file links to section navigation
  • Links to files that are included as sections (e.g., [CHANGELOG](CHANGELOG.md)) are rewritten to section anchors (#changelog)
  • Preserves external links and links to files that aren't sections
  • Centralized hash link monitoring with Alpine.js integration
  • Clicking any hash link now properly triggers section switching without page reloads
  • Added 4 tests for link rewriting functionality in test_builder.py

Installation

# Using uv (recommended)
uvx microdocs@1.1.0 README.md CHANGELOG.md

# Using pip
pip install --upgrade microdocs

🤖 Generated with Claude Code

v1.0

Version 1.0.0 (2025-11-13)

🎉 First stable release! Microdocs is now production-ready with comprehensive test coverage, CI/CD workflows, and a stable API.

Added

• Comprehensive test suite with 57 tests covering all functionality
  • test_builder.py - Tests for low-level conversion and building functions (25 tests)
  • test_cli.py - Tests for CLI interface functionality (19 tests)
  • test_templates.py - Tests for template rendering and integration (13 tests)
  • Uses pytest functions with fixtures following best practices
  • All tests pass linting with ruff
• Continuous Integration workflows
  • .github/workflows/test.yml - Runs tests across Python 3.11, 3.12, 3.13, 3.14
  • .github/workflows/lint.yml - Runs ruff check and format verification
• Testing infrastructure
  • runtests.sh - Executable script to run tests across all Python versions
  • Comprehensive testing documentation in CLAUDE.md
• README badges - Added PyPI version, test status, Python version support, and license badges

Changed

• Development status upgraded from Beta to Production/Stable
• Enhanced PyPI classifiers with better categorization for documentation and text processing

Deployment

# Using uv (recommended)
uvx microdocs@1.0 README.md CHANGELOG.md

# Using pip
pip install --upgrade microdocs

v0.3.0 - GitHub Action & Dark Mode Improvements

Added

• GitHub Action for one-step documentation deployment
  • Composite action that builds and deploys documentation to GitHub Pages
  • Auto-detects repository URL from GitHub context
  • Configurable inputs: files, title, output, template, repo-url, deploy, artifact-dir
  • Deploy enabled by default for seamless GitHub Pages deployment
  • Can be used for build-only workflows with deploy: false
  • Uses uvx for zero-installation execution
  • Comprehensive documentation in ACTION.md
• Local testing workflow - Test action locally with act tool
• Testing guide (TESTING.md) - Complete guide for testing the action locally with act

Fixed

• Dark mode typography - Improved readability in dark mode
  • Blockquotes now use readable light gray text instead of dark blue
  • Table borders use softer medium gray instead of harsh light colors
  • Table headers properly use light gray text for better visibility
  • All fixes properly scoped within @utility prose block in Tailwind CSS

Installation

# Using uv (recommended)
uvx microdocs@0.3 README.md CHANGELOG.md

# Using pip
pip install --upgrade microdocs