|
8 | 8 | - Allows setting custom footer text instead of automatic build timestamp |
9 | 9 | - Example: `microdocs README.md --footer "v1.1 2025-01-01"` |
10 | 10 | - Falls back to timestamp if not provided |
11 | | - |
12 | | -### Fixed |
13 | | - |
14 | | -- **TOC deep linking across sections** - Fixed table of contents links navigating to wrong section |
15 | | - - Heading IDs are now prefixed with section name (e.g., `readme-deep-dive`, `guide-deep-dive`) |
16 | | - - Prevents TOC links from jumping to identically-named headings in other sections |
17 | | - - Added custom `slugify` function to markdown `toc` extension for ID prefixing |
18 | | - - Added Playwright test to verify TOC navigation stays within correct section |
19 | | -- **Sticky header overlap** - Fixed headings appearing under sticky navigation when scrolling via TOC |
20 | | - - Added `scroll-padding-top: 86px` to CSS for proper anchor positioning |
21 | | - - Added `scroll-behavior: smooth` for smooth scrolling |
22 | | - - Configured Tocbot with `headingsOffset: 86` for accurate scroll spy detection |
23 | | - - Set `scrollSmooth: false` to let browser handle native scrolling behavior |
24 | | -- **Header title navigation** - Clicking the documentation title now returns to first section and scrolls to top |
25 | | - - Uses Alpine.js to set active section and scroll to page top |
26 | | - - Provides intuitive way to return to beginning of documentation |
| 11 | +- **Mobile Navigation** - Added responsive burger menu for mobile devices |
| 12 | + - Collapsible navigation menu for screens smaller than 640px |
| 13 | + - Smooth transition animations for menu toggle |
| 14 | + - Includes action buttons (theme toggle, repo link) in mobile view |
| 15 | + - Maintains clean row layout for desktop view |
| 16 | +- **Playwright testing infrastructure** for end-to-end template testing |
| 17 | + - `playwright/build-test-template.js` - Script to build and test templates with real content |
| 18 | + - `playwright/fixtures/` - Sample markdown files for testing |
| 19 | + - `playwright/playwright.config.js` - Playwright configuration |
| 20 | + - Playwright dependencies added to `package.json` |
| 21 | + - Test results directories added to `.gitignore` |
| 22 | +- **Vite configuration** (`vite.config.js`) |
| 23 | + - Auto-discovers template directories |
| 24 | + - Configures single-file builds with viteSingleFile plugin |
| 25 | + - Removes module attributes from inlined scripts |
| 26 | + - Minifies output with Terser |
| 27 | +- **Package build configuration** - Excluded development files from PyPI distribution |
| 28 | + - Excludes: `playwright/`, `templates_src/`, `node_modules/`, config files |
| 29 | +- **Image Row Detection** - Automatically detects and styles paragraphs containing only linked images |
| 30 | + - Applies `.image-row` class to paragraphs containing only linked images or SVGs |
| 31 | + - Supports multiple images per link (e.g. for complex badges) |
| 32 | + - Ensures proper alignment and spacing for badge rows |
27 | 33 |
|
28 | 34 | ### Changed |
29 | 35 |
|
|
39 | 45 | - Consolidated mobile and desktop navigation into single responsive component |
40 | 46 | - Removed duplicate `id="mobile-nav"` - now uses single `id="main-nav"` that adapts |
41 | 47 | - Reduced HTML payload by ~3KB and eliminated code duplication |
42 | | - |
43 | 48 | - **Markdown rendering improvements** - Enhanced markdown processing with GitHub-flavored features |
44 | 49 | - Added `mdx-truly-sane-lists` extension for proper nested list rendering with 2-space indentation |
45 | 50 | - Lists now render with correct `<ul>` nesting instead of flattening all items into a single list |
|
81 | 86 | - Updated CLAUDE.md with Vite workflow instructions |
82 | 87 | - Updated README.md with simplified template usage section |
83 | 88 |
|
84 | | -### Added |
| 89 | +### Fixed |
85 | 90 |
|
86 | | -- **Playwright testing infrastructure** for end-to-end template testing |
87 | | - - `playwright/build-test-template.js` - Script to build and test templates with real content |
88 | | - - `playwright/fixtures/` - Sample markdown files for testing |
89 | | - - `playwright/playwright.config.js` - Playwright configuration |
90 | | - - Playwright dependencies added to `package.json` |
91 | | - - Test results directories added to `.gitignore` |
92 | | -- **Vite configuration** (`vite.config.js`) |
93 | | - - Auto-discovers template directories |
94 | | - - Configures single-file builds with viteSingleFile plugin |
95 | | - - Removes module attributes from inlined scripts |
96 | | - - Minifies output with Terser |
97 | | -- **Package build configuration** - Excluded development files from PyPI distribution |
98 | | - - Excludes: `playwright/`, `templates_src/`, `node_modules/`, config files |
99 | | -- **Image Row Detection** - Automatically detects and styles paragraphs containing only linked images |
100 | | - - Applies `.image-row` class to paragraphs containing only linked images or SVGs |
101 | | - - Supports multiple images per link (e.g. for complex badges) |
102 | | - - Ensures proper alignment and spacing for badge rows |
| 91 | +- **TOC deep linking across sections** - Fixed table of contents links navigating to wrong section |
| 92 | + - Heading IDs are now prefixed with section name (e.g., `readme-deep-dive`, `guide-deep-dive`) |
| 93 | + - Prevents TOC links from jumping to identically-named headings in other sections |
| 94 | + - Added custom `slugify` function to markdown `toc` extension for ID prefixing |
| 95 | + - Added Playwright test to verify TOC navigation stays within correct section |
| 96 | +- **Sticky header overlap** - Fixed headings appearing under sticky navigation when scrolling via TOC |
| 97 | + - Added `scroll-padding-top: 86px` to CSS for proper anchor positioning |
| 98 | + - Added `scroll-behavior: smooth` for smooth scrolling |
| 99 | + - Configured Tocbot with `headingsOffset: 86` for accurate scroll spy detection |
| 100 | + - Set `scrollSmooth: false` to let browser handle native scrolling behavior |
| 101 | +- **Header title navigation** - Clicking the documentation title now returns to first section and scrolls to top |
| 102 | + - Uses Alpine.js to set active section and scroll to page top |
| 103 | + - Provides intuitive way to return to beginning of documentation |
103 | 104 |
|
104 | 105 | ### Removed |
105 | 106 |
|
|
0 commit comments