Skip to content

Commit 7349cf1

Browse files
committed
Try to make menu on left nicer with collpsable/expandable items
1 parent 242e737 commit 7349cf1

File tree

3 files changed

+26
-29
lines changed

3 files changed

+26
-29
lines changed

.github/workflows/docs.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ jobs:
2424
steps:
2525
- name: Checkout
2626
uses: actions/checkout@v4
27+
with:
28+
fetch-depth: 0
2729

2830
- name: Setup Python
2931
uses: actions/setup-python@v5
@@ -34,15 +36,14 @@ jobs:
3436
uses: actions/cache@v4
3537
with:
3638
path: ~/.cache/pip
37-
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
39+
key: ${{ runner.os }}-pip-mkdocs
3840
restore-keys: |
3941
${{ runner.os }}-pip-
4042
4143
- name: Install dependencies
4244
run: |
4345
python -m pip install --upgrade pip
44-
pip install mkdocs mkdocs-material mkdocs-mermaid2-plugin \
45-
mkdocs-git-revision-date-localized-plugin
46+
pip install mkdocs-material mkdocs-git-revision-date-localized-plugin
4647
4748
- name: Build documentation
4849
run: mkdocs build --strict
@@ -64,5 +65,4 @@ jobs:
6465
steps:
6566
- name: Deploy to GitHub Pages
6667
id: deployment
67-
uses: actions/deploy-pages@v4
68-
``
68+
uses: actions/deploy-pages@v4

docs/javascripts/mermaid.js

Lines changed: 0 additions & 6 deletions
This file was deleted.

mkdocs.yml

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ site_description: Documentation for Bold for Delphi - Model-Driven Architecture
33
site_url: https://bero.github.io/BoldForDelphi/
44
repo_url: https://github.com/bero/BoldForDelphi
55
repo_name: bero/BoldForDelphi
6-
edit_uri: edit/main/docs/
6+
edit_uri: edit/develop/docs/
77

88
theme:
99
name: material
@@ -23,11 +23,10 @@ theme:
2323
icon: material/brightness-4
2424
name: Switch to light mode
2525
features:
26-
- navigation.tabs
27-
- navigation.tabs.sticky
28-
- navigation.sections
29-
- navigation.expand
30-
- navigation.top
26+
- navigation.indexes # Section index pages (folder/index.md)
27+
- navigation.top # Back to top button
28+
- navigation.tracking # URL updates with anchor
29+
- toc.follow # TOC follows scroll position
3130
- search.suggest
3231
- search.highlight
3332
- content.code.copy
@@ -75,30 +74,34 @@ nav:
7574
- Persistence: concepts/persistence.md
7675
- Subscriptions: concepts/subscriptions.md
7776
- Logging: concepts/logging.md
78-
- Classes:
77+
- API Reference:
7978
- classes/index.md
80-
- TBoldSystem: classes/TBoldSystem.md
81-
- TBoldObject: classes/TBoldObject.md
82-
- TBoldObjectList: classes/TBoldObjectList.md
83-
- TBoldMember: classes/TBoldMember.md
84-
- TBoldAttribute: classes/TBoldAttribute.md
85-
- Examples: examples/index.md
79+
- Core Classes:
80+
- TBoldSystem: classes/TBoldSystem.md
81+
- TBoldObject: classes/TBoldObject.md
82+
- TBoldObjectList: classes/TBoldObjectList.md
83+
- Members:
84+
- TBoldMember: classes/TBoldMember.md
85+
- TBoldAttribute: classes/TBoldAttribute.md
86+
- Examples:
87+
- examples/index.md
8688
- Integrations:
8789
- integrations/index.md
8890
- DevExpress: integrations/devexpress.md
8991
- Development:
9092
- development/index.md
9193
- Unit Testing: development/testing.md
9294
- Codecov Setup: development/codecov.md
93-
- FAQ: faq.md
94-
- Roadmap: roadmap.md
95-
- Changelog: changelog.md
96-
- Contributing: contributing.md
95+
- Resources:
96+
- FAQ: faq.md
97+
- Roadmap: roadmap.md
98+
- Changelog: changelog.md
99+
- Contributing: contributing.md
97100

98101
extra:
99102
social:
100103
- icon: fontawesome/brands/github
101104
link: https://github.com/bero/BoldForDelphi
102105

103106
extra_javascript:
104-
- https://unpkg.com/mermaid
107+
- https://unpkg.com/mermaid@10/dist/mermaid.min.js

0 commit comments

Comments
 (0)