Skip to content

Commit

Permalink
Proper links
Browse files Browse the repository at this point in the history
  • Loading branch information
kastnerp committed Dec 7, 2024
1 parent 3932145 commit 4bbe320
Show file tree
Hide file tree
Showing 18 changed files with 92 additions and 845 deletions.
29 changes: 13 additions & 16 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,18 +1,15 @@
FROM squidfunk/mkdocs-material

# Install additional Python packages
RUN apk add --no-cache bash && \
pip install \
mkdocs-material \
mkdocs-multirepo-plugin \
mkdocs-git-revision-date-localized-plugin \
mkdocs-minify-plugin \
mkdocs-git-authors-plugin \
mkdocs-git-committers-plugin-2 \
mkdocs-title-casing-plugin \
mkdocs-glightbox \
markdown-include \
mkdocs-redirects \


# You can add more RUN pip install commands for other packages
# Install additional Python packages
RUN apk add --no-cache bash && \
pip install \
mkdocs-material \
mkdocs-multirepo-plugin \
mkdocs-git-revision-date-localized-plugin \
mkdocs-minify-plugin \
mkdocs-git-authors-plugin \
mkdocs-git-committers-plugin-2 \
mkdocs-title-casing-plugin \
mkdocs-glightbox \
markdown-include \
mkdocs-redirects
14 changes: 7 additions & 7 deletions docs/projects/24fa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

---

[:octicons-arrow-right-24: Learn more](/24fa-neuroarchitecture/)
[:octicons-arrow-right-24: Learn more](../../24fa-neuroarchitecture/README.md)

- :material-view-grid-plus:{ .lg .middle } __MPONC__

Expand All @@ -23,7 +23,7 @@

---

[:octicons-arrow-right-24: Learn more](/24fa-mponc/)
[:octicons-arrow-right-24: Learn more](../../24fa-mponc/README.md)

- :material-office-building:{ .lg .middle } __Energy in Commercial Buildings__

Expand All @@ -33,7 +33,7 @@

---

[:octicons-arrow-right-24: Learn more](/24fa-energyinbuildings-com/)
[:octicons-arrow-right-24: Learn more](../../24fa-energyinbuildings-com/README.md)

- :material-home:{ .lg .middle } __Energy in Residential Buildings__

Expand All @@ -43,7 +43,7 @@

---

[:octicons-arrow-right-24: Learn more](/24fa-energyinbuildings-res/)
[:octicons-arrow-right-24: Learn more](../../24fa-energyinbuildings-res/README.md)

- :material-weather-sunny:{ .lg .middle } __Urban Weather Generator (UWG)__

Expand All @@ -53,7 +53,7 @@

---

[:octicons-arrow-right-24: Learn more](/24fa-microclimate-uwg/)
[:octicons-arrow-right-24: Learn more](../../24fa-microclimate-lstm-kriging/README.md)

- :material-city-variant:{ .lg .middle } __Urban Microclimate Framework (UMCF)__

Expand All @@ -63,7 +63,7 @@

---

[:octicons-arrow-right-24: Learn more](/24fa-microclimate-umcf/)
[:octicons-arrow-right-24: Learn more](../../24fa-microclimate-umcf/README.md)

- :fontawesome-solid-person-walking:{ .lg .middle } __Pedestrian Environment Index (PEI)__

Expand All @@ -73,7 +73,7 @@

---

[:octicons-arrow-right-24: Learn more](/24fa-mobility-pei/)
[:octicons-arrow-right-24: Learn more](../../24fa-mobility-pei/README.md)

</div>

Expand Down
8 changes: 4 additions & 4 deletions docs/projects/24sp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

---

[:octicons-arrow-right-24: Learn more](/24sp-mobility-1/)
[:octicons-arrow-right-24: Learn more](../../24sp-mobility-1/README.md)

- :material-clock-time-five-outline:{ .lg .middle } __Segregation in the 15-Minute City__

Expand All @@ -24,7 +24,7 @@

---

[:octicons-arrow-right-24: Learn more](/24sp-mobility-2/)
[:octicons-arrow-right-24: Learn more](../../24sp-mobility-2/README.md)



Expand All @@ -36,7 +36,7 @@

---

[:octicons-arrow-right-24: Learn more](/24sp-microclimate/)
[:octicons-arrow-right-24: Learn more](../../24sp-microclimate/README.md)



Expand All @@ -48,7 +48,7 @@

---

[:octicons-arrow-right-24: Learn more](/24sp-energyinbuildings/)
[:octicons-arrow-right-24: Learn more](../../24sp-energyinbuildings/README.md)



Expand Down
98 changes: 49 additions & 49 deletions docs/team.md

Large diffs are not rendered by default.

14 changes: 10 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -171,18 +171,19 @@ plugins:
- get-involved.md
- index.md
enabled: true
enabled_on_serve: true
enabled_on_serve: false
strict: true
- git-committers:
repository: VIP-SMUR/wiki
branch: main
docs_path: docs/
- search:
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

- multirepo:
# (optional) tells multirepo to cleanup the temporary directory after site is built.
cleanup: false
cleanup: true
# if set the docs directory will not be removed when importing docs. When using this with a nav section in an imported repo
# you must keep the docs directory in the path (e.g., docs/path/to/file.md).
keep_docs_dir: true
nav_repos:
# Fall 2024
- name: get-involved
Expand Down Expand Up @@ -210,6 +211,9 @@ plugins:
- name: 24Fa-Mobility-PEI
import_url: https://github.com/VIP-SMUR/24Fa-Mobility-PEI?branch=main
imports: [/README.md]
# - name: TEST
# import_url: https://github.com/VIP-SMUR/Test?branch=main
# imports: [/README.md]

# Spring 2024
- name: 24Sp-EnergyInBuildings
Expand Down Expand Up @@ -240,6 +244,8 @@ nav:
- 24-Fa-Microclimate-LSTM-Kriging: 24fa-microclimate-lstm-kriging/README.md
- 24-Fa-Microclimate-UMCF: 24fa-microclimate-umcf/README.md
- 24-Fa-Mobility-PEI: 24fa-mobility-pei/README.md
# - Test: test/README.md


- Spring 2024:
- Projects: projects/24sp/README.md
Expand Down
4 changes: 2 additions & 2 deletions run_serve.bat
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ echo "###############"
echo.


REM mkdocs serve
mkdocs serve -a 127.0.0.1:8080
REM mkdocs serve -q
mkdocs serve -q -a 127.0.0.1:8080
8 changes: 7 additions & 1 deletion serve-docker.bat
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
REM Stop all running Docker containers
FOR /f "tokens=*" %%i IN ('docker ps -q') DO docker stop %%i
docker run --rm -it -p 8080:8000 -v %cd%:/docs custom-mkdocs-material

REM Run container with env file and quiet output
docker run --rm -it ^
-p 8080:8000 ^
-v %cd%:/docs ^
--env-file .env ^
custom-mkdocs-material
13 changes: 0 additions & 13 deletions temp_dir/24fa-energyinbuildings-com/README.md

This file was deleted.

13 changes: 0 additions & 13 deletions temp_dir/24fa-energyinbuildings-res/README.md

This file was deleted.

13 changes: 0 additions & 13 deletions temp_dir/24fa-microclimate-umcf/README.md

This file was deleted.

14 changes: 0 additions & 14 deletions temp_dir/24fa-microclimate-uwg/README.md

This file was deleted.

63 changes: 0 additions & 63 deletions temp_dir/24fa-mobility-pei/README.md

This file was deleted.

46 changes: 0 additions & 46 deletions temp_dir/24fa-mponc/README.md

This file was deleted.

Loading

0 comments on commit 4bbe320

Please sign in to comment.