Skip to content

Commit

Permalink
move images, use markdown syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
edasmalchi committed Jun 25, 2024
1 parent a072969 commit e434c19
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 5 deletions.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
10 changes: 5 additions & 5 deletions docs/publishing/sections/4_notebooks_styling.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,13 +119,13 @@ display(HTML(<h1>First Header</h1>) display(HTML(<h3>Next Header</h3>))
Markdown cells of the <i>H1</i> type creates the titles of our website, not the `.yml` file. Let's use [SB125 Route Illustrations](https://sb125-route-illustrations--cal-itp-data-analyses.netlify.app/readme) to demonstrate this.

- We can see that the [yml](https://github.com/cal-itp/data-analyses/blob/main/portfolio/sites/sb125_route_illustrations.yml) file lists the abbreviated county names as the parameter.
<img src="assets/section4_image5.png" width="350" />
![example yml file](../assets/section4_image5.png)

- However, the titles and headers in the notebook are the fully spelled out conunty names.
<img src="assets/section4_image3.png" width="350" />
![rendered notebook](../assets/section4_image3.png)

- This is due to the fact that the parameter is mapped to another variable in the [notebook](https://github.com/cal-itp/data-analyses/blob/main/sb125_analyses/path_examples_tttf4/path_examples.ipynb).
<img src="assets/section4_image4.png" width="350" />
![notebook heading](../assets/section4_image4.png)

## Getting Ready for Parameterization

Expand Down Expand Up @@ -164,7 +164,7 @@ Please note:
- This Markdown cell also creates the navigation on the lefthand side. Without this, the notebooks will be parameterized but then there'd be no table contents to list out the pages for people to see.
- Any styling (italicizing, bolding, changing the colors) you use in the markdown cell below will reflect in the Table of Contents.
- Below, you can see District 1: Eureka is displayed as the first header and is also the page's name in the Table of Content. Observe that the because the `# District` is bolded, the names on the left bar are also bolded.
- <img src="assets/section4_image1.png" width="400" />
![header format](../assets/section4_image1.png)

#### Code Cell:

Expand All @@ -179,7 +179,7 @@ You will need to create two separate code cells that take on the parameter. Let'
# district = "4"
```
- Turn on the parameter tag: go to the code cell go to the upper right hand corner -> click on the gears -> go to "Cell Tags" -> Add Tag + -> add a tag called "parameters" -> click on the new "parameters" tag to ensure a checkmark shows up and it turns dark gray.
- <img src="assets/section4_image2.png" width="250" />
![parameters tag](../assets/section4_image2.png)
- Code Cell #2:
Expand Down

0 comments on commit e434c19

Please sign in to comment.