Skip to content

Commit

Permalink
resolve rst vs md issues on ingested vm handbook
Browse files Browse the repository at this point in the history
  • Loading branch information
jensbri committed Nov 14, 2023
1 parent 4a54d94 commit e559c55
Show file tree
Hide file tree
Showing 39 changed files with 142 additions and 3,766 deletions.
11 changes: 10 additions & 1 deletion docs/Research Compute/Nectar.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# Nectar

The [Nectar Research Cloud](https://dashboard.rc.nectar.org.au/auth/login/?next=/project/) is an excellent resource for researchers to get access to a wide range of computational resources.

More details and a link to access it can be found on the [Research Hub](https://research-hub.auckland.ac.nz/research-software-and-computing/advanced-compute/nectar-research-cloud).

One common challenge is not to select the correct button for New Zealand.
![Login](../assets/NectarLogin.jpg){:width="50%"}

- mostly refer people to the (wonderful) documentation on the Nectar pages
- what is lacking:
- how to install Windows
- discuss a bit what Win10 vs. Server 2016 have for advantages/drawbacks
- how the Service Units are calculated. Give one example.
- how the Service Units are calculated. Give one example.


Binary file added docs/assets/IDS-Wizard-Dark.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/IDS-Wizard-Light.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/NectarLogin.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
556 changes: 0 additions & 556 deletions docs/index.html

This file was deleted.

57 changes: 54 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,9 @@ Some examples, fenced by the `++` characters:
- ++end++
- ++tab++

To add a custom label, you simply include this with double inverted commas

++"My Text"++

## Code Annotation Examples

Expand Down Expand Up @@ -221,8 +223,13 @@ def bubble_sort(items):
:octicons-heart-fill-24:{ .heart }


:fontawesome-brands-youtube:{ style="color: #EE0F0F" }
__[How to set up Material for MkDocs]__ by @james-willett – :octicons-clock-24:
15m – Learn how to create and host a documentation site using Material for
MkDocs on GitHub Pages in a step-by-step guide.

# Icons to use

# How to use Icons
- MKDocs comes with a lot of icons
- they are in the theme folder `.../venv/lib/python3.11/site-packages/material/templates/.icons/
- an efficient way to find the icon you want is to check [this website](https://pictogrammers.com/library/mdi/)
Expand All @@ -241,8 +248,52 @@ icon: mdi:account-arrow-down-outline

## Using Variable

<!-- here is a variable {{ macros_info() }} -->
My name is {{name_variable}}
the definition of the variables go in the `mkdocs.yml` file
` yaml hl_lines="3"`

## Including images

- images are stored in the `assets` folder
- VSC can provide a relative link
- the syntax is `![useful image](../assets/myimage.jpg)`
- you can also use the `:width="50%"` to resize the image
- you can also use the *hash fragments to make screenshots appear only in light or dark mode*
- `#only-light)`
- see example below

![Image title](../assets/IDS-Wizard-Light.jpg#only-light){ width=50% loading=lazy}
![Image title](../assets/IDS-Wizard-Dark.jpg#only-dark){ width=50% loading=lazy}
<!-- loading=lazy align=right -->

- If we feel the need for a slide-show, we can have a look at [glightbox](https://github.com/blueswen/mkdocs-glightbox#usage)
- We could also try to integrate a Python-based Macro to automatically add a lot of configurations (size, dark/light, alignment left, right, caption, ...)
- If we need captions, [Markdown doesn't support that natively](https://squidfunk.github.io/mkdocs-material/reference/images/#image-alignment), so we'd have to [use html](https://squidfunk.github.io/mkdocs-material/reference/images/#image-captions)

<figure markdown>
![Image title](https://dummyimage.com/600x400/){ width="20%" loading=lazy}
<figcaption>Image caption</figcaption>
</figure>


### Capturing Screen Shots

#### On a Mac
++cmd+shift+4++ then ++space++ (to select just the window) then while holding ++option++ you click which stores it in the default location



# Expanding content

- collapsible boxes ([see above](#admonitions-aka-call-outs))
- this is also an example of how to reference another section in the same document. Lowercase and hypen instead of spaces. Easy to get this is to load the final documentation. Click the link generation. Copy from the browser URL bar.
- [annotations](https://squidfunk.github.io/mkdocs-material/reference/annotations/#usage)



# Embedding Video

``` yaml hl_lines="3"
One example here
<div class="video-wrapper">
<iframe width="560" height="315" src="https://www.youtube.com/embed/bNVaT4Tmcn4?si=X39WC1SGLI0WRSYS" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</div>
Loading

0 comments on commit e559c55

Please sign in to comment.