Skip to content

Commit 29986b2

Browse files
committed
feat: enhance documentation with a modern introduction and detailed features overview
1 parent 125b469 commit 29986b2

File tree

2 files changed

+31
-9
lines changed

2 files changed

+31
-9
lines changed

docs/docs/index.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
1-
# Welcome to TPPT Documentation
1+
# About
22

3-
TPPT (Typed Python PowerPoint Tool) is a Python library for creating and manipulating PowerPoint presentations with type safety.
3+
✨ TPPT (Typed Python PowerPoint Tool) ✨
4+
5+
A modern Python library for creating beautiful PowerPoint presentations with code! 🚀
46

57
## Features
68

7-
- Type-safe PowerPoint presentation creation
8-
- Support for various Python versions (3.11+)
9-
- Rich set of features for slide manipulation
10-
- Extensible architecture
9+
📝 Write presentations in a clean, declarative style
10+
🛡️ Type-safe and Python 3.11+ ready
11+
🎨 Build beautiful slides with confidence
12+
💡 Focus on what matters: your content
13+
14+
- 🎯 **Advanced Slide Manipulation**
15+
- Create, modify, and delete slides programmatically
16+
- Support for all PowerPoint elements (text, shapes, images, charts)
17+
- Dynamic content generation
18+
19+
- 🔄 **Template Management**
20+
- Reusable slide templates
21+
- Style inheritance
22+
- Theme customization
23+
24+
- 📊 **Data Integration**
25+
- Seamless integration with pandas/polars DataFrames
26+
- Dynamic chart generation
27+
- Data-driven presentations
28+
29+
- 🛠️ **Developer Experience**
30+
- Comprehensive type hints
31+
- Detailed error messages
32+
- Extensive documentation
1133

1234
## Quick Start
1335

docs/mkdocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ theme:
2121
features:
2222
- navigation.tabs
2323
- navigation.sections
24-
- navigation.top
2524
- navigation.next
2625
- navigation.previous
2726
- search.suggest
@@ -78,8 +77,9 @@ markdown_extensions:
7877
permalink: true
7978

8079
nav:
81-
- Home: index.md
82-
- Installation: installation.md
80+
- Home:
81+
- About: index.md
82+
- Installation: installation.md
8383
- Usage: usage.md
8484
- API Reference: api/tppt.md
8585
- Examples: examples.md

0 commit comments

Comments
 (0)