Adding some content to the home page

docs/make.jl

@@ -65,7 +65,7 @@ function create_md_nb_file( notebook_path )
 end
 
 # Convert to html using nbconvert
-function convert_notebook_to_html(notebook_path; output_name = "index", output_dir = "./docs/src/notebook-output", theme = "dark")
+function convert_notebook_to_html(notebook_path; output_name = "index", output_dir = "./docs/src/notebook-output", theme = "light")
     command_jup = "jupyter"
     command_nbc = "nbconvert"
     output_format = "--to=html"
@@ -95,21 +95,21 @@ end
 
 # Replace colors to match Documenter.jl 
 function replace_colors(content)
-    content = replace( content, "--jp-layout-color0: #111111;" => "--jp-layout-color0: #1f2424;")
+    #content = replace( content, "--jp-layout-color0: #111111;" => "--jp-layout-color0: #1f2424;")
-    content = replace(content, "--md-grey-900: #212121;" => "--md-grey-900: #282f2f;")
+    #content = replace(content, "--md-grey-900: #212121;" => "--md-grey-900: #282f2f;")
     return content
 end
 
 # Loop over notebooks and generate html and markdown 
 notebook_files = glob("*.ipynb", "docs/src/notebooks/")
-for filepath in notebook_files
+#for filepath in notebook_files
-    convert_embedded_img_to_base64(filepath)
+#    convert_embedded_img_to_base64(filepath)
-    create_md_nb_file(filepath)
+#    create_md_nb_file(filepath)
-    filename_with_ext = splitpath(filepath)[end]    
+#    filename_with_ext = splitpath(filepath)[end]    
-    filename = splitext(filename_with_ext)[1]
+#    filename = splitext(filename_with_ext)[1]
-    convert_notebook_to_html(filepath, output_name = filename)
+#    convert_notebook_to_html(filepath, output_name = filename)
-    modify_notebook_html("docs/src/notebook-output/$(filename).html")
+#    modify_notebook_html("docs/src/notebook-output/$(filename).html")
-end
+#end
 
 makedocs(;
     modules=[XM_40017],
@@ -122,7 +122,7 @@ makedocs(;
         canonical="https://fverdugo.github.io/XM_40017",
         edit_link="main",),
     pages=["Home" => "index.md", "Notebooks"=>[
-        "Julia Tutorial" => "julia_tutorial.md",
+        "Getting started" => "julia_tutorial.md",
         "Why is Julia fast?" => "julia_intro.md",
         "Julia Basics" => "julia_basics.md",
         "Julia Asynchronous" => "julia_async.md",

docs/src/index.md

@@ -1,7 +1,57 @@
 ```@meta
 CurrentModule = XM_40017
 ```
-# XM_40017
+# Programming Large-Scale Parallel Systems (XM_40017)
 
-Welcome!
+Welcome to the interactive lecture notes of the [Programming Large-Scale Parallel Systems course](https://studiegids.vu.nl/EN/courses/2023-2024/XM_40017#/) at [VU Amsterdam](https://vu.nl)!
 
+## What
+
+This page contains part of the course material of the Programming Large-Scale Parallel Systems course at VU Amsterdam.
+Further information about this course is found in the study guide
+([click here](https://studiegids.vu.nl/EN/courses/2023-2024/XM_40017#/)) and our Canvas page (for registered students). This material consists of several lecture notes in jupyter notebook format, which will help you to learn how to design, analyze, and program parallel algorithms on multi-node computing systems.
+
+!!! note
+    This page contains only part of the course material. The rest is available on Canvas. In particular, **the lecture notes in this public webpage do not fully cover all topics in the final exam**.
+
+## How to use this page
+
+You have two main ways of running the notebooks:
+
+- Download the notebooks and run them locally on your computer (recommended)
+- Run the notebooks on the cloud via [mybinder.org](https://mybinder.org) (high startup time).
+
+You also have the static version of the notebooks displayed in this webpage for quick reference. At each notebook page you will find a green box with links to download the notebook or to open in on mybinder.
+
+## How to run the notebooks locally
+
+To run a notebook locally follow these steps:
+
+- Install Julia (if not done already). More information here.
+- Download the notebook.
+- Launch Julia. More information here.
+```
+   _       _ _(_)_     |  Documentation: https://docs.julialang.org
+  (_)     | (_) (_)    |
+   _ _   _| |_  __ _   |  Type "?" for help, "]?" for Pkg help.
+  | | | | | | |/ _` |  |
+  | | |_| | | | (_| |  |  Version 1.9.0 (2023-05-07)
+ _/ |\__'_|_|_|\__'_|  |  Official https://julialang.org/ release
+|__/                   |
+
+julia> 
+```
+- Execute these commands in the Julia command line:
+
+```
+julia> using Pkg
+julia> Pkg.add("IJulia")
+julia> using IJulia
+julia> notebook()
+```
+- These commands will open a jupyter in your web browser. Navigate in jupyter to the notebook file you have downloaded and open it.
+
+
+## Acknowledgment
+
+This page was created with the support of Faculty of Science of [Vrije Universiteit Amsterdam](https://vu.nl) in the framework of the project "Interactive lecture notes and exercises for the Programming Large-Scale Parallel Systems course" funded by the "Innovation budget BETA 2023 Studievoorschotmiddelen (SVM) towards Activated Blended Learning".