Skip to content

Commit 916a12a

Browse files
authored
Adding 2 plugins and enabling some ui additions. (#4)
Adding contributors and date last modified plugins 1) https://github.com/timvink/mkdocs-git-revision-date-localized-plugin 2) https://github.com/ojacques/mkdocs-git-committers-plugin-2
1 parent dbd265c commit 916a12a

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

.github/workflows/docs-deploy.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ jobs:
1212
runs-on: ubuntu-latest
1313
steps:
1414
- uses: actions/checkout@v4
15+
with:
16+
fetch-depth: 0
1517

1618
- name: Configure Git Credentials
1719
run: |
@@ -24,7 +26,7 @@ jobs:
2426
sudo apt install -y python3 python3-venv python3-pip
2527
python3 -m venv myenv
2628
source myenv/bin/activate
27-
pip install mkdocs-material
29+
pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2
2830
echo "cache_id=$(date --utc '+%F')" >> $GITHUB_ENV
2931
3032
- name: Configure cache

mkdocs.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
site_name: CAM-SIMA
2+
repo_url: https://github.com/ESCOMP/CAM-SIMA-docs
3+
repo_name: CAM-SIMA-docs
4+
edit_uri: edit/main/docs
25
nav:
36
- Home: index.md
47
- Conversion:
@@ -41,8 +44,18 @@ nav:
4144

4245
plugins:
4346
- search
47+
# Date plugin requires fetch-depth: 0
48+
- git-revision-date-localized:
49+
enable_creation_date: true
50+
- git-committers:
51+
repository: ESCOMP/CAM-SIMA-docs
52+
branch: main
53+
4454
theme:
4555
icon:
56+
repo: fontawesome/brands/github
57+
edit: material/pencil
58+
view: material/eye
4659
admonition:
4760
info: material/arrow-up-down-bold
4861
palette:
@@ -69,6 +82,8 @@ theme:
6982
name: material
7083
features:
7184
- content.code.copy
85+
- content.action.edit
86+
- content.action.view
7287

7388
markdown_extensions:
7489
- def_list

0 commit comments

Comments
 (0)