doc formatting fix (#114)

dowjones · Feb 8, 2023 · 32f8eba · 32f8eba
1 parent 1c5d5e7
commit 32f8eba
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -58,8 +58,6 @@ command](https://github.com/dowjones/tokendito/blob/main/docs/README.md#single-c
 Have multiple Okta tiles to switch between? View our [multi-tile
 guide](https://github.com/dowjones/tokendito/blob/main/docs/README.md#multi-tile-guide).
 
-### Tips, tricks, troubleshooting, examples, and more docs are [here]()https://github.com/dowjones/tokendito/blob/main/docs/README.md!
-[Contributions are welcome](https://github.com/dowjones/tokendito/blob/main/docs/CONTRIBUTING.md)!
 
 ## Docker
 
@@ -110,3 +108,7 @@ Tokendito profiles are supported while using containers provided the proper volu
 ``` txt
 docker run -ti -v ${home}:/home/tokendito/ tokendito --profile my-profile-name
 ```
+
+## Tips, tricks, troubleshooting, examples, and more docs are [here](https://github.com/dowjones/tokendito/blob/main/docs/README.md)
+
+[Contributions are welcome](https://github.com/dowjones/tokendito/blob/main/docs/CONTRIBUTING.md)!
diff --git a/docs/README.md b/docs/README.md
@@ -45,7 +45,7 @@ this!
 
 You can just pass in your information at runtime:
 
-``` sh
+``` txt
 tokendito --username prod_service_user@company.com \
 --role-arn arn:aws:iam::123456789000:role/dowjones-engineer \
 --okta-mfa push \
@@ -64,7 +64,7 @@ role_arn = arn:aws:iam::123456789000:role/engineer
 
 And execute:
 
-``` sh
+``` txt
 tokendito --profile engineer
 ```
 

diff --git a/tests/README.md b/tests/README.md
@@ -19,15 +19,15 @@ credentials.
 
 # Example 1
 
-``` sh
+``` txt
 py.test -v -rA -s tests --config-file=/tmp/my-tokendito-config.ini
 ```
 
 Where the config file has valid configuration items for the tool.
 
 ## Example 2
 
-``` sh
+``` txt
 py.test -v -rA -k 'functional' -s tests \
   --username=jane.doe@mycompany.com \
   --password=mysecretpass \
@@ -41,7 +41,7 @@ This triggers the tests `test_generate_credentials` and
 
 ## Example 3
 
-``` sh
+``` txt
 TOKENDITO_OKTA_MFA_METHOD=push py.test -v -rA -k 'functional' -s tests --username=...
 ```
 
@@ -50,7 +50,7 @@ arguments.
 
 ## Example 4
 
-``` sh
+``` txt
 TOKENDITO_OKTA_PASSWORD='mysecretpass' tox -e auth -- --username='jane.doe@mycompany.com'
 ```