Skip to content

Commit 3342fdb

Browse files
committed
feat: Introduce flexible templating with GitHub-hosted and local options, caching, and management commands.
1 parent 7eafede commit 3342fdb

File tree

3 files changed

+28
-3
lines changed

3 files changed

+28
-3
lines changed

CHANGELOG.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,31 @@ 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.3.0] - 2026-01-01
9+
10+
### Added
11+
12+
- **GitHub-Hosted Templates**: Fetch templates directly from GitHub repositories
13+
- Use `--template github:owner/repo` to specify a GitHub template
14+
- Support for specific branches/tags: `github:owner/repo#v1.0.0`
15+
- Support for subdirectories: `github:owner/repo/path/to/template`
16+
- **Template Caching**: Templates are cached locally for 24 hours in `~/.superdocs/templates/`
17+
- **Template Management Commands**:
18+
- `superdocs template list` - List available templates
19+
- `superdocs template cache --clear` - Clear template cache
20+
- **Force Refresh**: Use `--refresh` flag to bypass cache and re-download templates
21+
- **Local Templates**: Use local template folders with `--template ./path/to/template`
22+
- **Template Registry**: Shorthand names for official templates
23+
24+
### Changed
25+
26+
- Renamed `--theme` option to `--template` for clarity
27+
- Default template now fetched from GitHub instead of bundled
28+
29+
### Removed
30+
31+
- Bundled template (now fetched from `github:DevRohit06/superdocs-default-template`)
32+
833
## [0.2.2] - 2025-12-29
934

1035
### Fixed

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@devrohit06/superdocs",
3-
"version": "0.2.2",
3+
"version": "0.3.0",
44
"description": "The open-source Mintlify alternative. Beautiful documentation sites from Markdown.",
55
"main": "src/index.js",
66
"type": "module",
@@ -35,4 +35,4 @@
3535
"picocolors": "^1.1.1",
3636
"zod": "^3.23.0"
3737
}
38-
}
38+
}

src/cli.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export async function cli() {
1111
program
1212
.name('superdocs')
1313
.description('The open-source Mintlify alternative. Beautiful docs from Markdown.')
14-
.version('0.2.0');
14+
.version('0.3.0');
1515

1616
program
1717
.command('build')

0 commit comments

Comments
 (0)