Merge pull request #15 from TidbitSoftware/main

CHG: Updated local dev server install instructions; fix for syntax highlighting

Author: TidbitSoftware

docs/README.md

@@ -13,13 +13,25 @@ It can take up to 10 minutes for changes to your site to publish after you push
 ### Previewing Changes Locally
 Assuming [Jekyll] and [Bundler] are installed on your computer:
 
-1. Change your working directory to the root directory of your site.
+1. Change your working directory to `docs/` in the local copy of the repository.
 
 2. Run `bundle install`.
 
-3. Run `bundle exec jekyll serve --watch` to build your site and preview it at `localhost:4000`.
+3. Run `bundle exec jekyll serve --watch` to build your site.
 
-The built site is stored in the directory `_site/`.
+4. Preview the site in a web browser at `localhost:4000`.
+
+The built site is stored in and served from `_site/`.
+
+NOTE: The copy of Ruby included with macOS will likely not be of a new enough version. We suggest you install Ruby via Homebrew with,
+```
+brew install ruby
+```
+add the following to your `.bash_profile`,
+```
+export PATH="/opt/homebrew/opt/ruby/bin:${PATH}"
+```
+then start a new terminal and follow the above steps.
 
 ## Structure
 Each page in the [front end of the documentation](https://issmteam.github.io/ISSM-Documentation/) has a corresponding Markdown file (`.md`) in the appropriate subdirectory of `docs/`. For example,

docs/_config.yml

@@ -6,9 +6,6 @@ url: https://issmteam.github.io/ISSM-Documentation/
 
 color_scheme: issm
 
-markdown: kramdown
-highlighter: rouge
-
 # Site logo
 logo: "/assets/img/brand/ISSMlogo.png"
 

docs/_sass/custom/custom.scss

@@ -90,7 +90,31 @@
 	}
 }
 
-/* Sidebar expanded */
+/*
+	Code block styling
+*/
+.language-mat,
+.language-py
+{
+	padding: 1em;
+	border-radius: 0.5em;
+	display: block;
+	overflow-x: auto;
+}
+
+.language-mat {
+	background-color: #fff7f0 !important; // Light orange
+	color: #1a1a1a;
+}
+
+.language-py {
+	background-color: #f0fff4 !important; // Light greenish
+	color: #1a1a1a;
+}
+
+/*
+	Sidebar expanded
+*/
 @media (min-width: 800px) {
 	.post-index {
 		&.home-page-post-index {
@@ -117,24 +141,3 @@
 		}
 	}
 }
-
-/* Python code blocks */
-.language-python {
-  background-color: #f0fff4 !important; // Light greenish
-  color: #1a1a1a;
-}
-
-/* MATLAB code blocks */
-.language-matlab {
-  background-color: #fff7f0 !important; // Light orange
-  color: #1a1a1a;
-}
-
-/* Optional: Padding & border for visibility */
-.language-python,
-.language-matlab {
-  padding: 1em;
-  border-radius: 0.5em;
-  display: block;
-  overflow-x: auto;
-}

docs/using-issm/tutorials/squareiceshelf.md

@@ -43,13 +43,15 @@ Compute the velocity field of the ice shelf:
 ````
 
 Finally, generate a plot of the velocity:
-```python
->> plotmodel(md, 'data', md.results.StressbalanceSolution.Vel);
-```
 
-```matlab
+*MATLAB*
+```mat
 plotmodel(md, data=md.results.StressbalanceSolution.Vel)
 ```
 
+*Python*
+```py
+>> plotmodel(md, 'data', md.results.StressbalanceSolution.Vel);
+```
 
 <div style="display:flow-root"><img style="float:left;width:100.00%" src="/ISSM-Documentation/assets/img/docs/using-issm/tutorials/squareiceshelf/squarevel.png" alt="Figure 1: squarevel"></div>