Skip to content

Commit 4dcfc10

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

3 files changed

Lines changed: 28 additions & 33 deletions

File tree

.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: 23 additions & 22 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
@@ -39,6 +38,7 @@ plugins:
3938
separator: '[\\s\\-]+'
4039
- git-revision-date-localized:
4140
type: datetime
41+
enable_creation_date: true
4242

4343
markdown_extensions:
4444
- pymdownx.highlight:
@@ -51,7 +51,7 @@ markdown_extensions:
5151
custom_fences:
5252
- name: mermaid
5353
class: mermaid
54-
format: !!python/name:pymdownx.superfences.fence_code_format
54+
format: !!python/name:pymdownx.superfences.fence_mermaid_format
5555
- pymdownx.tabbed:
5656
alternate_style: true
5757
- admonition
@@ -75,30 +75,31 @@ nav:
7575
- Persistence: concepts/persistence.md
7676
- Subscriptions: concepts/subscriptions.md
7777
- Logging: concepts/logging.md
78-
- Classes:
78+
- API Reference:
7979
- 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
80+
- Core Classes:
81+
- TBoldSystem: classes/TBoldSystem.md
82+
- TBoldObject: classes/TBoldObject.md
83+
- TBoldObjectList: classes/TBoldObjectList.md
84+
- Members:
85+
- TBoldMember: classes/TBoldMember.md
86+
- TBoldAttribute: classes/TBoldAttribute.md
87+
- Examples:
88+
- examples/index.md
8689
- Integrations:
8790
- integrations/index.md
8891
- DevExpress: integrations/devexpress.md
8992
- Development:
9093
- development/index.md
9194
- Unit Testing: development/testing.md
9295
- Codecov Setup: development/codecov.md
93-
- FAQ: faq.md
94-
- Roadmap: roadmap.md
95-
- Changelog: changelog.md
96-
- Contributing: contributing.md
96+
- Resources:
97+
- FAQ: faq.md
98+
- Roadmap: roadmap.md
99+
- Changelog: changelog.md
100+
- Contributing: contributing.md
97101

98102
extra:
99103
social:
100104
- icon: fontawesome/brands/github
101-
link: https://github.com/bero/BoldForDelphi
102-
103-
extra_javascript:
104-
- https://unpkg.com/mermaid
105+
link: https://github.com/bero/BoldForDelphi

0 commit comments

Comments
 (0)