Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enabling some ui additions #4

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/docs-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Configure Git Credentials
run: |
Expand All @@ -24,7 +26,7 @@ jobs:
sudo apt install -y python3 python3-venv python3-pip
python3 -m venv myenv
source myenv/bin/activate
pip install mkdocs-material
pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2
echo "cache_id=$(date --utc '+%F')" >> $GITHUB_ENV

- name: Configure cache
Expand Down
15 changes: 15 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
site_name: CAM-SIMA
repo_url: https://github.com/ESCOMP/CAM-SIMA-docs
repo_name: CAM-SIMA-docs
edit_uri: edit/main/docs
nav:
- Home: index.md
- Conversion:
Expand Down Expand Up @@ -39,8 +42,18 @@ nav:

plugins:
- search
# Date plugin requires fetch-depth: 0
- git-revision-date-localized:
enable_creation_date: true
- git-committers:
repository: ESCOMP/CAM-SIMA-docs
branch: main

theme:
icon:
repo: fontawesome/brands/github
edit: material/pencil
view: material/eye
admonition:
info: material/arrow-up-down-bold
palette:
Expand All @@ -67,6 +80,8 @@ theme:
name: material
features:
- content.code.copy
- content.action.edit
- content.action.view

markdown_extensions:
- def_list
Expand Down