Skip to content

Commit e894568

Browse files
committed
docs: style
1 parent bc829a4 commit e894568

File tree

3 files changed

+64
-2
lines changed

3 files changed

+64
-2
lines changed

.github/pull_request_template.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Please describe the changes introduced by this Pull Request.
66
- What was changed?
77
- Why is this needed?
88

9+
For documentation-only PRs, focus on the Documentation checklist.
10+
911
---
1012

1113
## 🧪 Type of Change
@@ -15,7 +17,7 @@ Please mark the relevant option:
1517
- [ ] Bug fix
1618
- [ ] New feature
1719
- [ ] Refactoring
18-
- [ ] Documentation update
20+
- [ ] Documentation
1921
- [ ] Other
2022

2123
---
@@ -39,6 +41,16 @@ Please confirm:
3941

4042
---
4143

44+
## 📚 Documentation Checklist (if applicable)
45+
46+
- [ ] The documentation builds locally with `mkdocs serve`
47+
- [ ] All links were tested
48+
- [ ] Images use relative paths (e.g. `images/example.png`)
49+
- [ ] No references to the old GitHub Wiki
50+
- [ ] Navigation updated in `mkdocs.yml` (if required)
51+
52+
---
53+
4254
## 📝 Additional Notes
4355

4456
Add any other context or screenshots here.

docs/assets/logo.svg

Lines changed: 18 additions & 0 deletions
Loading

mkdocs.yml

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,27 @@ site_url: https://frangoteam.github.io/FUXA/
33

44
theme:
55
name: material
6+
logo: assets/logo.svg
7+
favicon: assets/logo.svg
8+
9+
palette:
10+
# Light mode
11+
- scheme: default
12+
toggle:
13+
icon: material/weather-sunny
14+
name: Switch to dark mode
15+
logo: assets/logo.svg
16+
17+
# Dark mode
18+
- scheme: slate
19+
toggle:
20+
icon: material/weather-night
21+
name: Switch to light mode
22+
logo: assets/logo.svg
623

724
nav:
825
- Home: index.md
26+
- Live Demo: https://frangoteam.github.io/
927
- Getting Started:
1028
- Installing and Running: Installing-and-Running.md
1129
- HowTo:
@@ -26,4 +44,18 @@ nav:
2644
- Widgets: HowTo-Widgets.md
2745
- WebSockets: HowTo-WebSockets.md
2846
- Settings: Settings.md
29-
- Tips and Tricks: Tips-and-Tricks.md
47+
- Tips and Tricks: Tips-and-Tricks.md
48+
49+
extra:
50+
social:
51+
- icon: fontawesome/brands/github
52+
link: https://github.com/frangoteam/FUXA
53+
name: GitHub Repository
54+
55+
- icon: fontawesome/brands/discord
56+
link: https://discord.gg/WZhxz9uHh4
57+
name: Discord Community
58+
59+
copyright: >
60+
Powered by <a href="https://frangoteam.org" target="_blank" rel="noopener">
61+
<strong>frangoteam</strong></a>

0 commit comments

Comments
 (0)