Skip to content

Commit e440785

Browse files
committed
feat: update CHANGELOG and README for version 0.7.0 enhancements and new commands
1 parent c766c10 commit e440785

2 files changed

Lines changed: 438 additions & 218 deletions

File tree

CHANGELOG.md

Lines changed: 113 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,94 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.7.0] - 2026-01-28
9+
10+
### Added
11+
12+
- **Multi-Framework Support**: Generate documentation sites with your preferred framework
13+
- Astro (default), React, Next.js, Vue, and Nuxt templates
14+
- Framework auto-detection from manifest or config files
15+
- Framework-specific dev and build commands
16+
- Use `--template react`, `--template next`, `--template vue`, or `--template nuxt`
17+
18+
- **Custom Landing Pages**: Full control over your documentation landing page
19+
- **Full Custom**: Create `_landing/` folder with HTML/CSS/JS files
20+
- **Section-Based**: Mix custom HTML sections with default components
21+
- Landing types: `none`, `default`, `config`, `custom`, `sections`
22+
- 10 section types: hero, features, cta, testimonials, pricing, faq, stats, logos, comparison, footer
23+
- Multi-framework landing generation (generates `.astro`, `.jsx`, `.vue` based on template)
24+
25+
- **`lito init` Command**: Interactive project initialization
26+
- Beautiful CLI prompts with @clack/prompts
27+
- Template selection with framework support
28+
- Creates `docs-config.json` with sensible defaults
29+
- Optional sample documentation pages (introduction.mdx, quickstart.mdx)
30+
- Auto-creates folder structure (`_assets`, `_images`)
31+
32+
- **`lito validate` Command**: Configuration validation
33+
- Validates `docs-config.json` against core schema
34+
- `--quiet` flag for CI pipelines (exit code only)
35+
- Shows configuration summary (metadata, navigation counts, features)
36+
- Portability check for cross-template compatibility
37+
38+
- **`lito doctor` Command**: Diagnose common issues
39+
- Checks directory and config file existence
40+
- Validates JSON syntax and schema compliance
41+
- Verifies content files exist (.md/.mdx)
42+
- Detects common mistakes (node_modules, package.json in docs folder)
43+
- Template cache status
44+
- Node.js version check (18+ required, 20+ recommended)
45+
46+
- **`lito info` Command**: Project information and statistics
47+
- Content stats: MD/MDX file counts, subdirectories
48+
- Navigation structure: sidebar groups/items, navbar links
49+
- Feature status: search, i18n, versioning, dark mode
50+
- Branding configuration overview
51+
- Config compatibility analysis
52+
- Environment info: Node.js version, platform, cached templates
53+
54+
- **`lito preview` Command**: Preview production builds locally
55+
- Auto-builds if output directory doesn't exist
56+
- Uses `serve` package or Python's http.server as fallback
57+
- Custom port support with `--port` flag
58+
59+
- **Configuration Validation System**: Portable config support
60+
- Core schema validation for cross-template compatibility
61+
- Core keys (portable): `metadata`, `branding`, `navigation`, `search`, `seo`, `i18n`, `assets`
62+
- Extension keys (template-specific): `footer`, `theme`, `landing`, `integrations`, `versioning`
63+
- Forward-compatible extension handling
64+
65+
- **Template Registry**: Shorthand names for official templates
66+
- `astro``github:Lito-docs/lito-astro-template`
67+
- `react``github:Lito-docs/lito-react-template`
68+
- `next``github:Lito-docs/lito-next-template`
69+
- `vue``github:Lito-docs/lito-vue-template`
70+
- `nuxt``github:Lito-docs/lito-nuxt-template`
71+
72+
### Changed
73+
74+
- **Framework-Aware Build Pipeline**: Build and dev commands now detect and use framework-specific tooling
75+
- **Enhanced Sync System**: Content syncing respects framework-specific directory structures
76+
- **HMR Support**: Hot module replacement trigger for Vite-based frameworks (React, Vue)
77+
- **Conditional Search Indexing**: Pagefind indexing only for static-output frameworks
78+
79+
### Improved
80+
81+
- **CLI UX**: Beautiful interactive prompts, spinners, and color-coded output
82+
- **Build Performance**: Parallel operations for faster builds (dependency install, docs sync, config sync)
83+
- **Error Messages**: More helpful error messages with actionable guidance
84+
85+
## [0.6.0] - 2026-01-15
86+
87+
### Added
88+
89+
- **Framework Runner**: Core abstraction for multi-framework support
90+
- **Landing Sync Module**: Foundation for custom landing page system
91+
92+
### Changed
93+
94+
- **Template Structure**: Updated default template paths for new framework templates
95+
896
## [0.5.2] - 2026-01-04
997

1098
### Added
@@ -32,146 +120,77 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
32120
- **Documentation Versioning**: Support for versioned documentation
33121
- **Hosting Provider Support**: New `--provider` option for optimized builds (Vercel, Netlify, Cloudflare, static)
34122
- **Rendering Modes**: New `--rendering` option supporting static, server, and hybrid modes
35-
- **Dynamic Theme Generation**: Generate OKLCH color palettes from primary color with automatic light/dark mode support
123+
- **Dynamic Theme Generation**: Generate OKLCH color palettes from primary color
36124
- **i18n Support**: Automatic detection and syncing of locale folders with 40+ language codes
37125
- **Asset Syncing**: Automatic syncing of `_assets`, `_images`, `_css`, and `public` folders
38126

39127
### Changed
40128

41129
- **Organization Migration**: Moved to official Lito-docs organization on GitHub
42-
- CLI repository: `Lito-docs/cli`
43-
- Template repository: `Lito-docs/template`
44-
- Documentation repository: `Lito-docs/docs`
45130
- **Default Template**: Updated default template source to `github:Lito-docs/template`
46-
- **Branding**: Updated project description to "Beautiful documentation sites from Markdown. Fast, simple, and open-source."
47-
- **Optimized Sync**: Improved sync pipeline with parallel processing for faster builds
48-
- **CLI Sync**: Improved sync to handle versioned documentation folders
49-
- **Smart Layout Injection**: Automatic layout detection (MarkdownLayout vs APILayout) based on frontmatter
50-
51-
### Improved
52-
53-
- **Code Quality**: Optimized async operations with Promise.all for parallel execution
54-
- **Error Handling**: Better error handling throughout the CLI pipeline
131+
- **Branding**: Updated project description
132+
- **Smart Layout Injection**: Automatic layout detection based on frontmatter
55133

56134
## [0.3.5] - 2026-01-02
57135

58136
### Added
59137

60-
- **CLI Config Options**: New command-line options for configuring documentation metadata and branding
61-
- `--name <name>` - Set project name directly from CLI
62-
- `--description <description>` - Set project description
63-
- `--primary-color <color>` - Set primary theme color (hex format)
64-
- `--accent-color <color>` - Set accent theme color (hex format)
65-
- `--favicon <path>` - Set favicon path
66-
- `--logo <path>` - Set logo path
67-
- **Enhanced Config Management**: CLI options now automatically update `docs-config.json` during build/dev/eject operations
138+
- **CLI Config Options**: `--name`, `--description`, `--primary-color`, `--accent-color`, `--favicon`, `--logo`
139+
- **Enhanced Config Management**: CLI options automatically update `docs-config.json`
68140

69141
### Removed
70142

71-
- **Unused Dependency**: Removed `zod` package (was not being used, reduces bundle size)
72-
73-
### Improved
74-
75-
- **Cleaner Dependencies**: Only 8 essential packages now (from 9)
76-
- **CLI Usability**: No need to manually edit `docs-config.json` for basic configuration
143+
- **Unused Dependency**: Removed `zod` package
77144

78145
## [0.3.0] - 2026-01-01
79146

80147
### Added
81148

82-
- **GitHub-Hosted Templates**: Fetch templates directly from GitHub repositories
83-
- Use `--template github:owner/repo` to specify a GitHub template
84-
- Support for specific branches/tags: `github:owner/repo#v1.0.0`
85-
- Support for subdirectories: `github:owner/repo/path/to/template`
86-
- **Template Caching**: Templates are cached locally for 24 hours in `~/.lito/templates/`
87-
- **Template Management Commands**:
88-
- `lito template list` - List available templates
89-
- `lito template cache --clear` - Clear template cache
90-
- **Force Refresh**: Use `--refresh` flag to bypass cache and re-download templates
91-
- **Local Templates**: Use local template folders with `--template ./path/to/template`
92-
- **Template Registry**: Shorthand names for official templates
149+
- **GitHub-Hosted Templates**: Fetch templates from `github:owner/repo`
150+
- **Template Caching**: 24-hour cache in `~/.lito/templates/`
151+
- **Template Management**: `lito template list` and `lito template cache --clear`
152+
- **Force Refresh**: `--refresh` flag to bypass cache
93153

94154
### Changed
95155

96-
- Renamed `--theme` option to `--template` for clarity
97-
- Default template now fetched from GitHub instead of bundled
98-
99-
### Removed
100-
101-
- Bundled template (now fetched from `github:Lito-docs/template`)
156+
- Renamed `--theme` to `--template`
157+
- Default template now fetched from GitHub
102158

103159
## [0.2.2] - 2025-12-29
104160

105161
### Fixed
106162

107-
- **Template**: Fixed all internal links (Sidebar, Header, Footer, Search, etc.) to correctly respect the `baseUrl` configuration.
108-
- **Navigation**: Updated Breadcrumbs, MobileNav, and PrevNextNav to support custom base URLs.
163+
- **Template**: Fixed internal links to respect `baseUrl` configuration
109164

110165
## [0.2.1] - 2025-12-29
111166

112167
### Fixed
113168

114-
- **Config**: Fixed `baseUrl` option not being applied to the Astro configuration. It now correctly patches `astro.config.mjs` when a custom base URL is provided.
169+
- **Config**: Fixed `baseUrl` not being applied to Astro configuration
115170

116171
## [0.2.0] - 2025-12-29
117172

118173
### Fixed
119174

120-
- **Eject**: Resolved build errors in ejected projects by properly handling dependencies and configuration.
175+
- **Eject**: Resolved build errors in ejected projects
121176

122177
### Improved
123178

124-
- **MDX Components**: Refined `Tabs` and `CodeGroup` components for better stability and rendering.
125-
- **Template**: Modernized documentation template with Astro 5 and Tailwind CSS v4 support.
179+
- **MDX Components**: Refined `Tabs` and `CodeGroup` components
180+
- **Template**: Modernized with Astro 5 and Tailwind CSS v4
126181

127-
## [0.1.0] - 2025-12-28 (Pre-Release)
182+
## [0.1.0] - 2025-12-28
128183

129184
### Added
130185

131186
- **CLI Tool**: Complete command-line interface for documentation generation
132187
- **Build Command**: Generate static documentation sites with `lito build`
133-
- **Dev Command**: Start a development server with hot reload using `lito dev`
134-
- **Eject Command**: Export full Astro project source code for customization with `lito eject`
135-
- **Astro Integration**: Built on Astro for lightning-fast static site generation
136-
- **Markdown & MDX Support**: Full support for both formats with frontmatter
137-
- **SEO Optimization**: Meta tags, semantic HTML, and proper structure
188+
- **Dev Command**: Development server with hot reload using `lito dev`
189+
- **Eject Command**: Export full Astro project with `lito eject`
190+
- **Astro Integration**: Lightning-fast static site generation
191+
- **Markdown & MDX Support**: Full support with frontmatter
192+
- **SEO Optimization**: Meta tags, semantic HTML
138193
- **Responsive Design**: Mobile-friendly documentation interface
139-
- **Rich Component Library**:
140-
- API Playground component
141-
- Breadcrumbs navigation
142-
- Search modal
143-
- Sidebar with grouping
144-
- Table of contents
145-
- Theme toggle
146-
- Tooltip component
147-
- Accordion, Alert, Badge, Cards, Code groups, and more
148-
- **Hot Reload**: Development server with file watching
149-
- **Fast Builds**: Optimized static site generation
194+
- **Rich Component Library**: API Playground, Breadcrumbs, Search, Sidebar, TOC, Theme Toggle, Accordion, Alert, Badge, Cards, Code groups, and more
195+
- **Hot Reload**: File watching in development
150196
- **Theme Support**: Custom themes and base URLs
151-
- **Project Scaffolding**: Automatic Astro project creation from templates
152-
- **Configuration Sync**: Dynamic config generation based on user options
153-
154-
### Dependencies
155-
156-
- `@astrojs/mdx`: ^3.1.0
157-
- `@clack/prompts`: ^0.11.0
158-
- `astro`: ^4.16.0
159-
- `chokidar`: ^4.0.0
160-
- `commander`: ^12.1.0
161-
- `execa`: ^9.0.0
162-
- `fs-extra`: ^11.2.0
163-
- `picocolors`: ^1.1.1
164-
165-
### Known Issues
166-
167-
- Search functionality implemented but may need further testing
168-
- Some advanced MDX features still being refined
169-
- Windows compatibility testing ongoing
170-
171-
### What's Next
172-
173-
- Enhanced search capabilities
174-
- Additional themes and customization options
175-
- Plugin system for extensions
176-
- Improved Windows support
177-
- More component integrations

0 commit comments

Comments
 (0)