Skip to content

Commit 5c70419

Browse files
authored
Merge pull request #56 from me-pic/ENH/layout
Integrate Material for Mkdocs functionalities
2 parents 836f982 + ce45216 commit 5c70419

File tree

4 files changed

+34
-5
lines changed

4 files changed

+34
-5
lines changed

docs/assets/images/favicon.png

36 KB
Loading

docs/assets/images/logo.png

138 KB
Loading

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Home
2-
Welcome to the main documentation site for the physiopy community and python package! Please also check out the package's [Github Page](https://github.com/physiopy). For questions, you can always contact the project manager at [[email protected]](mailto:[email protected]).
2+
Welcome to the main documentation site for the physiopy community and python packages! Please also check out our [Github Page](https://github.com/physiopy). For questions, you can always contact the project manager at [[email protected]](mailto:[email protected]).
33

44
<p align="center">
55
<img src="https://github.com/physiopy/phys2bids/blob/master/docs/_static/physiopy_logo_1280x640.png?raw=true" width="400">
66
</p>
77

88
## Who are we?
9-
We are the physiopy development team consisting of an international group of volunteers. You can learn more about us by visiting the [*Community*](/community/index) page. Contributions are also very much welcomed! Check out the [*Contributors*](/community/contributor-guide) tab.
9+
We are the physiopy development team consisting of an international group of volunteers. You can learn more about us and how to connect with us by visiting the [*Community*](/community) page. Contributions are also very much welcomed! Check out the [*Contributor Guide*](community/contributor-guide/) tab.
1010

1111
## What is the importance of physiological data collection and its impact on MRI?
1212

13-
Physiological data provides the representation of the participant with respect to extension of bodily information (i.e., heart rates, respiratory rate, skin conductance etc.). Monitoring one's physiological activity helps us understand the percerption of cognition, emotion, motivation etc. Additionaly, physiological data is a key component in understanding physiological sources of signal variance in fMRI data. Collecting these data helps to provide more accurate models of fMRI time-series. It also provides a real-time method to monitor subjects during scanning. See the [*Best Practices* section](/best_practices) for recommendations from key personnel in the field on physiological data collection and analysis.
13+
Physiological data provides a rich representation of a research subject with respect to their bodily information (i.e., heart rate, respiratory rate and depth of breathing, skin conductance, etc.). Examining physiological activity helps us to understand the perception and embodied experience of cognition, emotion, motivation, and more. Additionaly, physiological data is a key component in understanding physiological sources of signal variance in fMRI data. Collecting these data helps to provide more accurate models of fMRI time-series. It also provides a real-time method to monitor subjects during scanning. See the [*Community Practices* documentation](https://physiopy-community-guidelines.readthedocs.io/en/latest/index.html) for recommendations from key personnel in the field on physiological data collection and analysis.

mkdocs.yml

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,45 @@ site_name: Physiopy
22
site_description: Physiopy
33
site_author: The Physiopy developers
44
site_url: https://physiopy.github.io
5+
repo_url: https://github.com/physiopy/physiopy.github.io
6+
repo_name: physiopy/physiopy.github.io
57

68
# Copyright
79
copyright: Copyright &copy; 2020-2024, The Physiopy Community
810

11+
# Set up theme with Material for Mkdocs
12+
theme:
13+
name: material
14+
favicon: assets/images/favicon.png
15+
logo: assets/images/logo.png
16+
icon:
17+
repo: fontawesome/brands/github
18+
features:
19+
- navigation.tabs
20+
- navigation.indexes
21+
- navigation.sections
22+
palette:
23+
# Palette toggle for light mode
24+
- scheme: default
25+
toggle:
26+
icon: material/brightness-7
27+
name: Switch to dark mode
28+
29+
# Palette toggle for dark mode
30+
- scheme: slate
31+
toggle:
32+
icon: material/brightness-4
33+
name: Switch to light mode
34+
35+
# Content of the website
936
nav:
1037
- Home: index.md
1138
- Libraries:
1239
- phys2bids: libraries/phys2bids.md
1340
- phys2denoise: libraries/phys2denoise.md
1441
- peakdet: libraries/peakdet.md
15-
- Community Practices: https://physiopy-community-guidelines.readthedocs.io/en/latest/index.html
42+
- Community Practices:
43+
- Community Practices: https://physiopy-community-guidelines.readthedocs.io/en/latest/index.html
1644
- Community:
1745
- Welcome: community/index.md
1846
- Getting Started: community/gettingstarted.md
@@ -21,7 +49,8 @@ nav:
2149
- Other Tools: community/other_tools.md
2250
- Code of Conduct: community/CODE_OF_CONDUCT.md
2351
- Team: community/team.md
24-
- OHBM 2023 Tutorials: ohbm23_tutorials.md
52+
- Tutorials:
53+
- OHBM 2023 Tutorials: ohbm23_tutorials.md
2554

2655

2756

0 commit comments

Comments
 (0)