Skip to content

Commit 4b29361

Browse files
committed
Update docs workflow and mkdocs config: add PlantUML support, edit/view actions, and enable advanced navigation features 🤩
1 parent e0e790b commit 4b29361

2 files changed

Lines changed: 24 additions & 1 deletion

File tree

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
python-version: '3.12'
2626

2727
- name: Install mkdocs-material
28-
run: pip install mkdocs-material
28+
run: pip install mkdocs-material plantuml-markdown
2929

3030
- name: Build and deploy to gh-pages (develop/)
3131
run: |

mkdocs.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ site_description: A PHP library for reading, creating, and manipulating GPX file
33
site_url: https://sibyx.github.io/phpGPX/develop/
44
repo_url: https://github.com/Sibyx/phpGPX
55
repo_name: Sibyx/phpGPX
6+
edit_uri: edit/develop/docs/
67

78
theme:
89
name: material
@@ -22,28 +23,50 @@ theme:
2223
icon: material/brightness-4
2324
name: Switch to light mode
2425
features:
26+
- navigation.instant
27+
- navigation.instant.progress
28+
- navigation.tracking
2529
- navigation.sections
2630
- navigation.expand
2731
- navigation.top
32+
- navigation.indexes
33+
- navigation.path
2834
- content.code.copy
2935
- content.code.annotate
36+
- content.action.edit
37+
- content.action.view
38+
- search.suggest
3039
- search.highlight
40+
- search.share
41+
- toc.follow
3142
icon:
3243
repo: fontawesome/brands/github
44+
edit: material/pencil
45+
view: material/eye
3346

3447
markdown_extensions:
3548
- admonition
3649
- pymdownx.details
3750
- pymdownx.superfences
3851
- pymdownx.highlight:
3952
anchor_linenums: true
53+
line_spans: __span
54+
pygments_lang_class: true
55+
auto_title: true
4056
- pymdownx.inlinehilite
57+
- pymdownx.snippets
4158
- pymdownx.tabbed:
4259
alternate_style: true
60+
- pymdownx.mark
61+
- plantuml_markdown:
62+
server: https://www.plantuml.com/plantuml
63+
format: svg
4364
- tables
4465
- toc:
4566
permalink: true
4667
- attr_list
68+
- md_in_html
69+
- def_list
4770

4871
nav:
4972
- Home: index.md

0 commit comments

Comments
 (0)