Skip to content

Commit e8b6b27

Browse files
committed
Website should now work with mystmd.
1 parent a26dd51 commit e8b6b27

File tree

4 files changed

+9
-24
lines changed

4 files changed

+9
-24
lines changed

.github/workflows/deploy-book.yml

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,14 @@ jobs:
2323
run: |
2424
pip install -r content/requirements.txt
2525
26-
# Fetch ORCID records
27-
- name: Fetch ORCID records
28-
run: |
29-
cd content; python orcid_to_bib.py
30-
3126
# Build the page
3227
- name: Build the book
3328
run: |
34-
jupyter-book build content/
29+
myst build --html
3530
3631
# Push the book's HTML to github-pages
3732
- name: GitHub Pages action
3833
uses: peaceiris/actions-gh-pages@v4
3934
with:
4035
github_token: ${{ secrets.GITHUB_TOKEN }}
41-
publish_dir: ./content/_build/html
36+
publish_dir: _build/html

README.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# simexp.github.io
22
Website of the laboratory for brain simulation and exploration (SIMEXP). The codebase of this website is licensed under a
3-
[Creative Commons Attribution 4.0 International License][cc-by].
3+
[Creative Commons Attribution 4.0 International License][cc-by] and is based on the [Myst Markdown](https://mystmd.org/) framework.
44

55
## Usage
66

@@ -11,18 +11,9 @@ If you'd like to develop and/or build the SIMEXP website, you should:
1111
1. Clone this repository
1212
2. Run `pip install -r content/requirements.txt` (it is recommended you do this within a virtual environment)
1313
3. (Optional) Edit the books source files located in the `content/` directory
14-
4. In a terminal, move to the `content` directory
15-
5. Run `python orcid_to_bib.py` to update the content of the publication section.
16-
4. Run `jupyter-book clean .` to remove any existing builds
17-
5. Run `jupyter-book build .` to create the book
14+
4. Run `myst build --html` to create the website
1815

19-
A fully-rendered HTML version of the book will be built in `content/_build/html/`.
20-
21-
### Hosting the book
22-
23-
Please see the [Jupyter Book documentation](https://jupyterbook.org/publish/web.html) to discover options for deploying a book online using services such as GitHub, GitLab, or Netlify.
24-
25-
For GitHub and GitLab deployment specifically, the [cookiecutter-jupyter-book](https://github.com/executablebooks/cookiecutter-jupyter-book) includes templates for, and information about, optional continuous integration (CI) workflow files to help easily and automatically deploy books online with GitHub or GitLab. For example, if you chose `github` for the `include_ci` cookiecutter option, your book template was created with a GitHub actions workflow file that, once pushed to GitHub, automatically renders and pushes your book to the `gh-pages` branch of your repo and hosts it on GitHub Pages when a push or pull request is made to the main branch.
16+
A fully-rendered HTML version of the book will be built in `_build/html/`. If a change is merged into `main`, a github action will automatically publish an updated version of the website.
2617

2718
## Contributors
2819

content/intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# SIMEXP
22

3-
![](images/banner.png)
3+
![](../images/banner.png)
44

5-
The laboratory for brain simulation and exploration (SIMEXP) is located in Montreal and affiliated with the [CRIUGM](https://criugm.qc.ca/), [CSS-MTL](https://ciusss-centresudmtl.gouv.qc.ca/) and [Université de Montréal](https://psy.umontreal.ca/accueil/). The main objective of the lab is to train artificial neural networks in order to jointly mimic individual human brain activity and behaviour. To achieve that goal, we lead an intensive effort of individual data collection in neuroimaging (fMRI, MEG), the Courtois project on neuronal modelling ([CNeuroMod](https://cneuromod.ca)). The SIMEXP lab also applies machine learning techniques to identify robust markers of brain disorders in multisite data.
5+
The laboratory for brain simulation and exploration (SIMEXP) is located in Montreal and affiliated with the [CRIUGM](https://criugm.qc.ca/), [CSS-MTL](https://ciusss-centresudmtl.gouv.qc.ca/) and [Université de Montréal](https://psy.umontreal.ca/accueil/). The main objective of the lab is to train artificial neural networks in order to jointly mimic individual human brain activity and behaviour, notably leading the Courtois project on neuronal modelling ([CNeuroMod](https://cneuromod.ca)). The SIMEXP lab also translates these models to identify markers of brain disorders using neuroimaging data.
66

77
::::{grid}
88

myst.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,12 @@ project:
1414
- file: content/manifesto.md
1515
- file: content/coc.md
1616
- file: content/members.md
17-
- file: content/publications.md
1817
- file: content/contributing.md
1918
- title: Alliance Canada
2019
children:
2120
- file: alliance_canada/quick_start.md
2221
site:
2322
template: book-theme
2423
options:
25-
favicon: content/images/favicon.png
26-
logo: content/images/simexp.png
24+
favicon: images/favicon.png
25+
logo: images/simexp.png

0 commit comments

Comments
 (0)