Skip to content

Commit d33e3c1

Browse files
committed
version update
1 parent e76c494 commit d33e3c1

File tree

6 files changed

+180
-13
lines changed

6 files changed

+180
-13
lines changed

Cargo.lock

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ thiserror = "2.0"
1010
walkdir = "2.3"
1111

1212
[workspace.package]
13-
version = "0.3.0"
13+
version = "0.4.0"
1414
edition = "2021"
1515
authors = ["bahdotsh"]
1616
license = "MIT"

README.md

Lines changed: 116 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ A fast, lightweight static site generator built in Rust for creating and managin
2323

2424
**Site Generation**
2525
- Fast static site builds
26-
- Multiple themes: Minimal Retro, Obsidian, Terminal Candy, and Dark Minimal
26+
- Multiple themes: 7 built-in themes for blogs and personal sites
27+
- Blog: Minimal Retro, Obsidian, Terminal Candy
28+
- Personal: Dark Minimal, Musashi, Slate Portfolio, Typewriter (NEW)
2729
- Full-text search with MiniSearch integration
2830
- Syntax highlighting for code blocks
2931
- RSS/Atom feeds (blog mode)
@@ -337,6 +339,40 @@ fn main() {
337339
```
338340
```
339341
342+
## Personal Website Content
343+
344+
For personal mode (`--personal`), use `content.md` with frontmatter to define your site:
345+
346+
```markdown
347+
---
348+
title: "Your Name"
349+
description: "Your tagline or role"
350+
author: "Your Name"
351+
theme: "typewriter"
352+
theme_config:
353+
show_paper_texture: true
354+
typing_animation: true
355+
sections:
356+
about:
357+
title: "About Me"
358+
content: |
359+
<p>Your introduction here...</p>
360+
tagline: "One keystroke at a time"
361+
362+
contact:
363+
title: "Get In Touch"
364+
text: "Let's connect!"
365+
366+
social:
367+
github: "https://github.com/yourusername"
368+
twitter: "https://twitter.com/yourusername"
369+
linkedin: "https://linkedin.com/in/yourusername"
370+
blog: "https://yourblog.com" # NEW in v0.4.0
371+
---
372+
```
373+
374+
**Note**: In personal mode, the `title` and `description` from `content.md` will override the values in `blogr.toml`.
375+
340376
## Search
341377

342378
Blogr includes a powerful client-side full-text search feature powered by MiniSearch. Search is enabled by default and works entirely in the browser without requiring a server.
@@ -462,14 +498,41 @@ Blogr comes with multiple built-in themes, each designed for different purposes:
462498
- Customizable status bar
463499
- Perfect for portfolios and personal brands
464500

501+
**Musashi** (dynamic personal sites)
502+
- Modern dynamic content loading
503+
- Smooth animations and transitions
504+
- Clean typography
505+
- Responsive design
506+
- Perfect for personal websites and project showcases
507+
508+
**Slate Portfolio** (professional portfolios)
509+
- Modern glassmorphic design
510+
- Frosted glass effects
511+
- Elegant transitions
512+
- Professional layout
513+
- Perfect for freelancers and professionals
514+
515+
**Typewriter** (NEW in v0.4.0 - vintage personal sites)
516+
- Vintage typewriter-inspired aesthetics
517+
- Cream paper background with subtle texture
518+
- Monospace Courier font family
519+
- Typewriter typing animation for title
520+
- Blinking cursor effect
521+
- Vintage date stamp
522+
- Typewriter-style line separators
523+
- Perfect for writers, bloggers, and literary portfolios
524+
465525
### Theme Commands
466526
```bash
467527
blogr theme list # Show available themes
468528
blogr theme set minimal-retro # Switch to Minimal Retro theme
469529
blogr theme set obsidian # Switch to Obsidian theme
470530
blogr theme set terminal-candy # Switch to Terminal Candy theme
471531
blogr theme set dark-minimal # Switch to Dark Minimal theme
472-
blogr theme info dark-minimal # Show theme configuration options
532+
blogr theme set musashi # Switch to Musashi theme
533+
blogr theme set slate-portfolio # Switch to Slate Portfolio theme
534+
blogr theme set typewriter # Switch to Typewriter theme
535+
blogr theme info typewriter # Show theme configuration options
473536
```
474537

475538
### Dark Minimal Theme Configuration
@@ -523,12 +586,39 @@ status_color = "#ff00ff" # Magenta
523586
show_status_bar = false
524587
```
525588

589+
### Typewriter Theme Configuration
590+
591+
The Typewriter theme offers vintage customization options:
592+
593+
```toml
594+
[theme]
595+
name = "typewriter"
596+
597+
[theme.config]
598+
# Colors
599+
paper_color = "#f4f1e8" # Vintage cream paper
600+
ink_color = "#2b2b2b" # Dark charcoal ink
601+
accent_color = "#8b4513" # Vintage brown accent
602+
603+
# Typography
604+
font_family = "'Courier Prime', 'Courier New', monospace"
605+
606+
# Visual Effects
607+
show_paper_texture = true # Subtle paper texture overlay
608+
typing_animation = true # Typewriter typing animation
609+
show_date_stamp = true # Vintage date stamp
610+
cursor_blink = true # Blinking cursor effect
611+
```
612+
526613
### Available Themes:
527614

528615
- **Minimal Retro** - Clean, artistic design with retro aesthetics (for blogs)
529616
- **Obsidian** - Adopts Obsidian community themes for familiar note-taking styling (for blogs)
530-
- **Terminal Candy** - Quirky terminal-inspired theme with pastel colors (for personal sites)
617+
- **Terminal Candy** - Quirky terminal-inspired theme with pastel colors (for blogs/personal)
531618
- **Dark Minimal** - Dark minimalist-maximalist with cyberpunk aesthetics (for personal sites)
619+
- **Musashi** - Dynamic modern theme with smooth animations (for personal sites)
620+
- **Slate Portfolio** - Glassmorphic professional portfolio theme (for personal sites)
621+
- **Typewriter** - Vintage typewriter aesthetics with nostalgic charm (for personal sites)
532622

533623
**Obsidian Theme Setup**
534624

@@ -973,6 +1063,29 @@ Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines
9731063
- Documentation
9741064
- Testing
9751065

1066+
## Changelog
1067+
1068+
### v0.4.0 (Latest)
1069+
1070+
**New Features:**
1071+
- 🎨 **Typewriter Theme**: Vintage typewriter-inspired theme for personal websites with nostalgic aesthetics
1072+
- 🔗 **Blog Link Support**: All personal website themes now support a `blog` link in social links
1073+
- 📝 **Content.md Override**: Personal mode now uses `title` and `description` from `content.md` instead of `blogr.toml`
1074+
-**Conditional Separators**: Typewriter theme displays separator lines only when sections are present
1075+
1076+
**Improvements:**
1077+
- Better theme organization with clear separation between blog and personal themes
1078+
- Enhanced personal website customization options
1079+
- Improved documentation for all themes
1080+
1081+
**Themes:**
1082+
- Blog themes: Minimal Retro, Obsidian, Terminal Candy
1083+
- Personal themes: Dark Minimal, Musashi, Slate Portfolio, Typewriter
1084+
1085+
### Previous Versions
1086+
1087+
See [blogr-themes/README.md](blogr-themes/README.md) for detailed theme changelog.
1088+
9761089
## License
9771090

9781091
MIT License - see [LICENSE](LICENSE) for details.

blogr-cli/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ name = "blogr"
1212
path = "src/main.rs"
1313

1414
[dependencies]
15-
blogr-themes = { version = "0.3.0", path = "../blogr-themes" }
15+
blogr-themes = { version = "0.4.0", path = "../blogr-themes" }
1616
clap = { version = "4.0", features = ["derive"] }
1717
ratatui = "0.24"
1818
crossterm = "0.27"

blogr-themes/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "blogr-themes"
3-
version = "0.3.0"
3+
version = "0.4.0"
44
edition.workspace = true
55
authors.workspace = true
66
license.workspace = true

blogr-themes/README.md

Lines changed: 59 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Blogr Themes is a library that provides the theme system for the Blogr static si
88

99
## Version
1010

11-
**Current Version**: `0.2.0`
11+
**Current Version**: `0.4.0`
1212

1313
This crate uses independent versioning from the main Blogr CLI to allow for theme-specific updates and improvements.
1414

@@ -24,18 +24,59 @@ This crate uses independent versioning from the main Blogr CLI to allow for them
2424

2525
## Built-in Themes
2626

27-
### Minimal Retro
27+
### Blog Themes
28+
29+
#### Minimal Retro
2830
- **Version**: 1.0.0
2931
- **Style**: Clean, artistic design with retro typography
3032
- **Features**: Warm color palette, serif fonts, minimalist layout
3133
- **Best for**: Personal blogs, creative writing, photography
3234

33-
### Obsidian
34-
- **Version**: 1.0.0
35+
#### Obsidian
36+
- **Version**: 1.0.0
3537
- **Style**: Modern dark theme inspired by Obsidian
3638
- **Features**: Dark/light mode, purple accents, clean typography
3739
- **Best for**: Technical blogs, documentation, note-taking style content
3840

41+
#### Terminal Candy
42+
- **Version**: 1.0.0
43+
- **Style**: Quirky terminal-inspired design with pastel colors
44+
- **Features**: Glitch effects, ASCII art, typewriter animations
45+
- **Best for**: Creative personal blogs, tech enthusiasts
46+
47+
### Personal Website Themes
48+
49+
#### Dark Minimal
50+
- **Version**: 1.0.0
51+
- **Style**: Dark minimalist theme with neon accents
52+
- **Features**: Cyberpunk aesthetic, animated backgrounds, customizable status bar
53+
- **Best for**: Personal portfolios, designer/developer showcases
54+
55+
#### Musashi
56+
- **Version**: 1.0.0
57+
- **Style**: Dynamic content-loading theme with modern aesthetics
58+
- **Features**: Smooth animations, clean typography, responsive design
59+
- **Best for**: Personal websites, project showcases
60+
61+
#### Slate Portfolio
62+
- **Version**: 1.0.0
63+
- **Style**: Modern glassmorphic portfolio theme
64+
- **Features**: Frosted glass effects, elegant transitions, professional layout
65+
- **Best for**: Professional portfolios, freelancers
66+
67+
#### Typewriter (NEW in v0.4.0)
68+
- **Version**: 1.0.0
69+
- **Style**: Vintage typewriter-inspired theme with nostalgic aesthetics
70+
- **Features**:
71+
- Vintage cream paper background with subtle texture
72+
- Monospace Courier font family
73+
- Typewriter typing animation for title
74+
- Blinking cursor effect
75+
- Vintage date stamp
76+
- Typewriter-style line separators
77+
- Configurable paper texture, animations, and cursor
78+
- **Best for**: Writers, bloggers, literary portfolios, creative professionals
79+
3980
## Usage
4081

4182
### As a Library
@@ -44,7 +85,7 @@ Add to your `Cargo.toml`:
4485

4586
```toml
4687
[dependencies]
47-
blogr-themes = "0.2.0"
88+
blogr-themes = "0.4.0"
4889
```
4990

5091
### Basic Usage
@@ -311,6 +352,19 @@ See the main [CONTRIBUTING.md](../CONTRIBUTING.md) for detailed guidelines.
311352

312353
## Changelog
313354

355+
### v0.4.0
356+
- **NEW**: Typewriter theme for personal websites with vintage aesthetics
357+
- **NEW**: Blog link support in all personal website themes (Dark Minimal, Musashi, Slate Portfolio, Typewriter)
358+
- **IMPROVED**: Personal mode now uses title and description from content.md instead of blogr.toml
359+
- **IMPROVED**: Conditional separator lines in Typewriter theme based on section presence
360+
- **ADDED**: Vintage typewriter effects including typing animation, blinking cursor, and paper texture
361+
362+
### v0.3.0
363+
- **NEW**: Personal website themes (Dark Minimal, Musashi, Slate Portfolio)
364+
- **NEW**: Terminal Candy theme for blogs
365+
- **IMPROVED**: Better theme organization for blog vs personal modes
366+
- **ADDED**: Personal mode support with section-based layouts
367+
314368
### v0.2.0
315369
- **NEW**: Obsidian theme improvements
316370
- **IMPROVED**: Better responsive design across all themes

0 commit comments

Comments
 (0)