Skip to content

Commit f7f68eb

Browse files
andrzejnovakclaude
andcommitted
fix: correct example dropdown URLs and simplify landing page
- Update Examples dropdown links to use relative URLs that work both locally and on GitHub Pages - Simplify landing page by removing excessive HTML styling and grids - Remove emoji icons from section headers for cleaner appearance 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 3f9faea commit f7f68eb

2 files changed

Lines changed: 25 additions & 54 deletions

File tree

example/docs/index.md

Lines changed: 21 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -2,53 +2,24 @@
22

33
Add configurable dropdown menus to your MkDocs Material theme header for easy cross-documentation navigation.
44

5-
<div style="text-align: center; margin: 2rem 0;">
6-
<a href="/getting-started/" style="display: inline-block; padding: 0.75rem 2rem; background: var(--md-primary-fg-color); color: white; text-decoration: none; border-radius: 0.25rem; font-weight: bold; margin: 0.5rem;">Get Started</a>
7-
<a href="https://github.com/cms-cat/mkdocs-header-dropdown-plugin" target="_blank" style="display: inline-block; padding: 0.75rem 2rem; border: 2px solid var(--md-primary-fg-color); color: var(--md-primary-fg-color); text-decoration: none; border-radius: 0.25rem; font-weight: bold; margin: 0.5rem;">View on GitHub</a>
8-
</div>
9-
10-
## ✨ Features
11-
12-
<div style="display: grid; grid-template-columns: repeat(auto-fit, minmax(250px, 1fr)); gap: 1.5rem; margin: 2rem 0;">
13-
<div>
14-
<h3>🎯 Simple Configuration</h3>
15-
<p>Define dropdown menus in YAML - no template overrides needed</p>
16-
</div>
17-
<div>
18-
<h3>📦 Shared Configs</h3>
19-
<p>Load from external files via git submodules - perfect for organizations</p>
20-
</div>
21-
<div>
22-
<h3>🔄 Nested Menus</h3>
23-
<p>Create multi-level submenus with automatic arrow indicators</p>
24-
</div>
25-
<div>
26-
<h3>🎨 Customizable</h3>
27-
<p>Add icons, customize titles, and style to match your theme</p>
28-
</div>
29-
<div>
30-
<h3>🌙 Theme Integration</h3>
31-
<p>Works seamlessly with Material theme's light and dark modes</p>
32-
</div>
33-
<div>
34-
<h3>♿ Accessible</h3>
35-
<p>Keyboard-friendly navigation and screen reader support</p>
36-
</div>
37-
</div>
38-
39-
## 🎪 Live Demo
40-
41-
**Look at the header above!** You'll see three dropdown menus demonstrating the plugin's capabilities:
42-
43-
| Dropdown | Description | Demonstrates |
44-
|----------|-------------|--------------|
45-
| **CMS POG Docs** | External links with icon | Shared config via git submodule |
46-
| **Examples** | Internal site links | Direct mkdocs.yml configuration |
47-
| **Resources** | Mixed with nested menu | Nested dropdowns (hover over "Documentation") |
48-
49-
Try interacting with them to see how the plugin works!
50-
51-
## 🚀 Quick Start
5+
## Features
6+
7+
- **Simple Configuration**: Define dropdown menus in YAML - no template overrides needed
8+
- **Shared Configs**: Load from external files via git submodules - perfect for organizations
9+
- **Nested Menus**: Create multi-level submenus with automatic arrow indicators
10+
- **Customizable**: Add icons, customize titles, and style to match your theme
11+
- **Theme Integration**: Works seamlessly with Material theme's light and dark modes
12+
- **Accessible**: Keyboard-friendly navigation and screen reader support
13+
14+
## Live Demo
15+
16+
Look at the header above to see the plugin in action! The dropdowns demonstrate:
17+
18+
- **CMS POG Docs**: External links with icon (shared config via git submodule)
19+
- **Examples**: Internal site links (direct mkdocs.yml configuration)
20+
- **Resources**: Mixed with nested menu (hover over "Documentation" to see submenu)
21+
22+
## Quick Start
5223

5324
### For Organizations (Shared Links)
5425

@@ -88,20 +59,20 @@ plugins:
8859
target: "_blank"
8960
```
9061
91-
## 📦 Installation
62+
## Installation
9263
9364
```bash
9465
pip install git+https://github.com/cms-cat/mkdocs-header-dropdown-plugin.git
9566
```
9667

97-
## 📚 Documentation
68+
## Documentation
9869

9970
- **[Getting Started](getting-started.md)** - Installation and basic setup
10071
- **[Configuration Examples](examples.md)** - Real-world configuration patterns
10172
- **[Nested Menus](nested-menus.md)** - Creating multi-level submenus
10273
- **[GitHub Repository](https://github.com/cms-cat/mkdocs-header-dropdown-plugin)** - Source code and issues
10374

104-
## 💡 Use Cases
75+
## Use Cases
10576

10677
- **Organization-wide navigation**: Share common links across all documentation sites
10778
- **Multi-project documentation**: Link between related projects

example/mkdocs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ plugins:
3636
- title: "Examples"
3737
links:
3838
- text: "Overview"
39-
url: "/"
39+
url: "index.html"
4040
- text: "Getting Started"
41-
url: "/getting-started/"
41+
url: "getting-started/"
4242
- text: "Configuration Examples"
43-
url: "/examples/"
43+
url: "examples/"
4444
- text: "Nested Menus"
45-
url: "/nested-menus/"
45+
url: "nested-menus/"
4646
- title: "Resources"
4747
links:
4848
- text: "GitHub Repository"

0 commit comments

Comments
 (0)