Merge pull request #7 from hubmapconsortium/Derek-Furst/update-clt-docs

Fixed alignment in usage code block. Added highlighting to misc code sections
hubmapconsortium · Jul 1, 2024 · b34a60d · b34a60d
2 parents 5f8f446 + 9cbd72d
commit b34a60d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 12 deletions.
diff --git a/docs/clt/index.md b/docs/clt/index.md
@@ -9,7 +9,8 @@ The HuBMAP Command Line Transfer utility provides the functionality to download
 This document covers usage of the HuBMAP CLT. Detailed instructions for installing hubmap-clt as well as other first 
 time setup can be found [here](install-hubmap-clt.html). A [tutorial](view-globus-download-location.html) on how to view the current GCP download directory is also available.
 
-usage: hubmap-clt [-h &#124; --help &#124; -v &#124; --version] [transfer manifest-file &#124; login &#124; logout &#124; whoami]
+<pre>   usage: hubmap-clt [-h &#124; --help &#124; -v &#124; --version] [transfer manifest-file &#124;  
+   login &#124; logout &#124; whoami]</pre>
 
 Commands: One of the following commands is required:
 
@@ -29,17 +30,17 @@ Commands: One of the following commands is required:
                             a message will be displayed prompting the user
 			                to log in.
 
--h or --help  Show this help message.
+  -h or --help              Show this help message.
 
--d or --destination	Manually select a download location within the user's
-                        home direcotry. For example:
-                          'hubmap-clt transfer manifest-file -d Desktop'
-            			will download to the user's Desktop directory. The 
-			            directory will be created under the user home directory
-			            if it doesn't already exist.
+  -d or --destination	    Manually select a download location within the 
+                            user's home direcotry. For example:
+                            'hubmap-clt transfer manifest-file -d Desktop'
+            			    will download to the user's Desktop directory. The 
+			                directory will be created under the user home 
+                            directory if it doesn't already exist.
 
--v or --version        Displays the version of the currently installed 
-                       hubmap-sdk package
+  -v or --version           Displays the version of the currently installed 
+                            hubmap-sdk package
 
 ```
 

diff --git a/docs/clt/view-globus-download-location.md b/docs/clt/view-globus-download-location.md
@@ -7,9 +7,9 @@ layout: page
 All Globus downloads via the HuBMAP-CLT will be performed relative to the default Globus directory or "Home Folder".
 This may not necessarily be your usual Home directory. On Windows for example, your current Documents directory is 
 often chosen by Globus as the Home Folder. This can be complicated further with One Drive. For example: if your Globus Home 
-Folder is "User\OneDrive\Documents" and, using the HuBMAP-CLT \[--destination] option, you set your download location to be
+Folder is "User\OneDrive\Documents" and, using the ```HuBMAP-CLT \[--destination]``` option, you set your download location to be
 "Desktop", you'll find your downloads have been placed in "User\OneDrive\Documents\Desktop" rather than your actual 
-desktop directory.For this reason it is recommended that you confirm the location of the Globus Home Folder following the instructions in [Using the HuBMAP CLT](using-hubmap-clt.html). This process will be slightly different if depending on your operating system. 
+desktop directory. For this reason it is recommended that you confirm the location of the Globus Home Folder following the instructions in [Using the HuBMAP CLT](using-hubmap-clt.html). This process will be slightly different if depending on your operating system. 
 
 <details>
 <summary>Windows Tutorial</summary>