From e434c1922e9dac030ac28f167e564ce18587700d Mon Sep 17 00:00:00 2001 From: Eric Dasmalchi Date: Tue, 25 Jun 2024 16:29:00 -0700 Subject: [PATCH] move images, use markdown syntax --- .../{sections => }/assets/section4_image1.png | Bin .../{sections => }/assets/section4_image2.png | Bin .../{sections => }/assets/section4_image3.png | Bin .../{sections => }/assets/section4_image4.png | Bin .../{sections => }/assets/section4_image5.png | Bin docs/publishing/sections/4_notebooks_styling.md | 10 +++++----- 6 files changed, 5 insertions(+), 5 deletions(-) rename docs/publishing/{sections => }/assets/section4_image1.png (100%) rename docs/publishing/{sections => }/assets/section4_image2.png (100%) rename docs/publishing/{sections => }/assets/section4_image3.png (100%) rename docs/publishing/{sections => }/assets/section4_image4.png (100%) rename docs/publishing/{sections => }/assets/section4_image5.png (100%) diff --git a/docs/publishing/sections/assets/section4_image1.png b/docs/publishing/assets/section4_image1.png similarity index 100% rename from docs/publishing/sections/assets/section4_image1.png rename to docs/publishing/assets/section4_image1.png diff --git a/docs/publishing/sections/assets/section4_image2.png b/docs/publishing/assets/section4_image2.png similarity index 100% rename from docs/publishing/sections/assets/section4_image2.png rename to docs/publishing/assets/section4_image2.png diff --git a/docs/publishing/sections/assets/section4_image3.png b/docs/publishing/assets/section4_image3.png similarity index 100% rename from docs/publishing/sections/assets/section4_image3.png rename to docs/publishing/assets/section4_image3.png diff --git a/docs/publishing/sections/assets/section4_image4.png b/docs/publishing/assets/section4_image4.png similarity index 100% rename from docs/publishing/sections/assets/section4_image4.png rename to docs/publishing/assets/section4_image4.png diff --git a/docs/publishing/sections/assets/section4_image5.png b/docs/publishing/assets/section4_image5.png similarity index 100% rename from docs/publishing/sections/assets/section4_image5.png rename to docs/publishing/assets/section4_image5.png diff --git a/docs/publishing/sections/4_notebooks_styling.md b/docs/publishing/sections/4_notebooks_styling.md index 6e5d3c4621..68377f3fd2 100644 --- a/docs/publishing/sections/4_notebooks_styling.md +++ b/docs/publishing/sections/4_notebooks_styling.md @@ -119,13 +119,13 @@ display(HTML(

First Header

) display(HTML(

Next Header

)) Markdown cells of the H1 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. - + ![example yml file](../assets/section4_image5.png) - However, the titles and headers in the notebook are the fully spelled out conunty names. - + ![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). - + ![notebook heading](../assets/section4_image4.png) ## Getting Ready for Parameterization @@ -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. - - + ![header format](../assets/section4_image1.png) #### Code Cell: @@ -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. - - + ![parameters tag](../assets/section4_image2.png) - Code Cell #2: