Skip to content

Commit f0ae38e

Browse files
Add mkdocs-table-reader-plugin and enhance navigation structure; implement table sorting functionality
1 parent 32f0c72 commit f0ae38e

4 files changed

Lines changed: 47 additions & 20 deletions

File tree

.github/workflows/Docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ jobs:
4040
pip install mkdocs-git-committers-plugin-2
4141
pip install mkdocs-rss-plugin
4242
pip install "mkdocs-material[imaging]"
43+
pip install mkdocs-table-reader-plugin
4344
4445
- name: Build mkdocs-material project
4546
run: |

docs/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@ Our approach centers around a development framework that allows developers to fo
55
By leveraging the GitHub platform and PowerShell, we aim to automate the repetitive tasks, enabling developers — whether as consumers or contributors
66
— to concentrate on coding without distractions.
77

8+
``` mermaid
9+
graph LR
10+
A[Start] --> B{Error?};
11+
B -->|Yes| C[Hmm...];
12+
C --> D[Debug];
13+
D --> B;
14+
B ---->|No| E[Yay!];
15+
```
16+
817
## Supported Platforms
918

1019
This development framework is built to serve the needs of modern developers and environments. We prioritize supporting the latest Long-Term Servicing

mkdocs.yml

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -54,25 +54,25 @@ theme:
5454
- content.code.copy
5555

5656
nav:
57-
- Home: index.md
58-
- Projects:
59-
- PowerShell Modules:
60-
- PowerShell-Modules/index.md
61-
- Test-Specification: PowerShell-Modules/Test-Specification.md
62-
- Versioning: PowerShell-Modules/Versioning.md
63-
- GitHub Actions:
64-
- GitHub-Actions/index.md
65-
- Some More: GitHub-Actions/Some-More.md
66-
- Test Something: GitHub-Actions/Test-Something.md
67-
- Subtopic:
68-
- GitHub-Actions/Subtopic/index.md
69-
- Some More: GitHub-Actions/Subtopic/Some-More.md
70-
- Test Something: GitHub-Actions/Subtopic/Test-Something.md
71-
- Solutions:
72-
- Solutions/index.md
73-
- Blog:
74-
- Blog/index.md
75-
- About: About/index.md
57+
- Home: index.md
58+
- Projects:
59+
- PowerShell Modules:
60+
- PowerShell-Modules/index.md
61+
- Test-Specification: PowerShell-Modules/Test-Specification.md
62+
- Versioning: PowerShell-Modules/Versioning.md
63+
- GitHub Actions:
64+
- GitHub-Actions/index.md
65+
- Some More: GitHub-Actions/Some-More.md
66+
- Test Something: GitHub-Actions/Test-Something.md
67+
- Subtopic:
68+
- GitHub-Actions/Subtopic/index.md
69+
- Some More: GitHub-Actions/Subtopic/Some-More.md
70+
- Test Something: GitHub-Actions/Subtopic/Test-Something.md
71+
- Solutions:
72+
- Solutions/index.md
73+
- Blog:
74+
- Blog/index.md
75+
- About: About/index.md
7676

7777
repo_name: PSModule/docs
7878
repo_url: https://github.com/PSModule/docs
@@ -82,6 +82,7 @@ copyright: Copyright © 2023 - 2025 PSModule
8282
plugins:
8383
- meta
8484
- search
85+
- table-reader # https://timvink.github.io/mkdocs-table-reader-plugin/
8586
- blog:
8687
blog_dir: Blog
8788
blog_toc: true
@@ -105,7 +106,13 @@ markdown_extensions:
105106
- attr_list
106107
- admonition
107108
- md_in_html
109+
- tables
108110
- pymdownx.details # Enables collapsible admonitions
111+
- pymdownx.superfences:
112+
custom_fences:
113+
- name: mermaid
114+
class: mermaid
115+
format: !!python/name:pymdownx.superfences.fence_code_format
109116

110117
extra:
111118
social:
@@ -127,4 +134,8 @@ extra:
127134
- reject
128135

129136
extra_css:
130-
- assets/stylesheets/extra.css
137+
- assets/stylesheets/extra.css
138+
139+
extra_javascript:
140+
- https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
141+
- assets/javascripts/tablesort.js
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
document$.subscribe(function () {
2+
var tables = document.querySelectorAll("article table:not([class])")
3+
tables.forEach(function (table) {
4+
new Tablesort(table)
5+
})
6+
})

0 commit comments

Comments
 (0)