diff --git a/docs/assets/images/favicon.png b/docs/assets/images/favicon.png new file mode 100644 index 0000000..6a24954 Binary files /dev/null and b/docs/assets/images/favicon.png differ diff --git a/docs/assets/images/logo.png b/docs/assets/images/logo.png new file mode 100644 index 0000000..3f2de90 Binary files /dev/null and b/docs/assets/images/logo.png differ diff --git a/docs/index.md b/docs/index.md index 5719bce..30e1d74 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,13 +1,13 @@ # Home -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 [physiopy.community@gmail.com](mailto:physiopy.community@gmail.com). +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 [physiopy.community@gmail.com](mailto:physiopy.community@gmail.com).

## Who are we? -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. +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. ## What is the importance of physiological data collection and its impact on MRI? -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. +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. diff --git a/mkdocs.yml b/mkdocs.yml index 8498be2..5f07a30 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,17 +2,45 @@ site_name: Physiopy site_description: Physiopy site_author: The Physiopy developers site_url: https://physiopy.github.io +repo_url: https://github.com/physiopy/physiopy.github.io +repo_name: physiopy/physiopy.github.io # Copyright copyright: Copyright © 2020-2024, The Physiopy Community +# Set up theme with Material for Mkdocs +theme: + name: material + favicon: assets/images/favicon.png + logo: assets/images/logo.png + icon: + repo: fontawesome/brands/github + features: + - navigation.tabs + - navigation.indexes + - navigation.sections + palette: + # Palette toggle for light mode + - scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to light mode + +# Content of the website nav: - Home: index.md - Libraries: - phys2bids: libraries/phys2bids.md - phys2denoise: libraries/phys2denoise.md - peakdet: libraries/peakdet.md - - Community Practices: https://physiopy-community-guidelines.readthedocs.io/en/latest/index.html + - Community Practices: + - Community Practices: https://physiopy-community-guidelines.readthedocs.io/en/latest/index.html - Community: - Welcome: community/index.md - Getting Started: community/gettingstarted.md @@ -21,7 +49,8 @@ nav: - Other Tools: community/other_tools.md - Code of Conduct: community/CODE_OF_CONDUCT.md - Team: community/team.md - - OHBM 2023 Tutorials: ohbm23_tutorials.md + - Tutorials: + - OHBM 2023 Tutorials: ohbm23_tutorials.md