Skip to content

Commit

Permalink
Add czi
Browse files Browse the repository at this point in the history
  • Loading branch information
skoudoro committed Dec 28, 2023
1 parent d31fa6b commit bc6650f
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 9 deletions.
30 changes: 22 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,8 @@ We use Github Action to deploy the website and Github Page to host the [website]
- `_templates`: Contains html layout for custom Sphinx design.
- `_build`: Contains the generated documentation.
- `sphinxext`: Sphinx custom plugins.
- `theory`: Diffusion theory + FAQ files.
- `tools`: Contains all scripts to generate some parts of the documentation, like the API.
- `posts`: Contains all blog posts.
- `context`: Contains the homepage content description

## Testing Locally: Doc generation steps:

Expand Down Expand Up @@ -159,13 +158,28 @@ Please select the more appropriate one, for many `update` or `news` would be eno

For tags, you can choose what you prefer for your post but please don't use any that are in the categories list.

## Adding an image to the carousel
## Adding an image to the Sponsor section

- **Step 1.** Make sure you have a correct banner aspect ratio. it should respect the "Billboard Banner" aspect ratio (970x250).
Look [here for more information](https://www.match2one.com/blog/standard-banner-sizes/#:~:text=Billboard)
- **Step 2.** Commit and push your banner in https://github.com/dipy/dipy_data
- **Step 3.** Get the github raw URL of your banner
- **Step 4.** Create a new `[[carousel_slides]]` section and add this link in the [context.toml file](https://github.com/dipy/dipy.org/blob/15a48e058f76be5e76977e71ee5b108077ba9512/context/context.toml#L1). Note that order have an importance. Your new section should look like this:
- **Step 1.** Make sure you have a correct image size. The sponsor section images should be squared.
- **Step 2.** Commit and push your images in the subfolder `_static/images/sponsors`
- **Step 2.bis (optional).** If your not satisfied with the layout (grid system), edit the `_templates/components/sponsors.html` file to improve the rendering.
- **Step 3.** Create a new `[[sponsors]]` section and add the image name in the [context.toml file](https://github.com/dipy/dipy.org/blob/15a48e058f76be5e76977e71ee5b108077ba9512/context/context.toml#L1). Note that order have an importance. Your new section should look like this:

```python
[[sponsors]]
name = "Indiana University"
image = "iu.webp"
url = "https://www.iu.edu/"
```


## Adding an image to the Carousel section

- **Step 1.** Make sure you have the correct banner aspect ratio. it should respect the "Billboard Banner" aspect ratio (970x250). Look [here for more information](https://www.match2one.com/blog/standard-banner-sizes/#:~:text=Billboard)

- **Step 2.** Commit and push your banner at https://github.com/dipy/dipy_data
- **Step 3.** Get the GitHub raw URL of your banner
- **Step 4.** Create a new `[[carousel_slides]]` section and add this link in the [context.toml file](https://github.com/dipy/dipy.org/blob/15a48e058f76be5e76977e71ee5b108077ba9512/context/context.toml#L1). Note that order has importance. Your new section should look like this:
```python
[[carousel_slides]]
caption = "EVAC+, ISMRM 2023"
Expand Down
Binary file added _static/images/sponsors/czi_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion _templates/components/sponsors.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<h2 class="section-title">Sponsors</h2>
<div class="grid-5 sponsors">
<div class="grid-3 sponsors" style="padding-left: 15%;padding-right: 15%;">
{% for sponsor in sponsors %}
<a href="{{ sponsor.url }}" class="sponsors-item" target="_blank">
<img src="_static/images/sponsors/{{ sponsor.image }}" alt="{{ sponsor.name }}">
Expand Down
5 changes: 5 additions & 0 deletions context/context.toml
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,8 @@ url = "https://www.iu.edu/"
name = "UW eScience Institute"
image = "uwescience.png"
url = "https://escience.washington.edu/"

[[sponsors]]
name = "Chan Zuckerberg Initiative"
image = "czi_logo.png"
url = "https://chanzuckerberg.com/eoss/proposals/strengthening-computational-neuroanatomy-using-dipy/"

0 comments on commit bc6650f

Please sign in to comment.