Use Material theme for documentation (#681)

xen0l · Dec 23, 2020 · e442e9a · e442e9a
1 parent de55b04
commit e442e9a
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 17 deletions.
diff --git a/docs/command-line.md b/docs/command-line.md
@@ -1,4 +1,6 @@
-# bootstrap
+# Command line arguments
+
+## bootstrap
 
 Download and install session-manager-plugin
 
@@ -10,7 +12,7 @@ optional arguments:
   -f, --force  Forces bootstrap operation
 ```
 
-# exec
+## exec
 
 Execute interactive command on instance
 
@@ -29,7 +31,7 @@ optional arguments:
                         AWS region to use
 ```
 
-# session
+## session
 
 Open new session on instance and connect to it
 
@@ -47,7 +49,7 @@ optional arguments:
                         AWS region to use
 ```
 
-# ssh
+## ssh
 
 Open new SSH session on instance and connect to it
 
@@ -70,7 +72,7 @@ optional arguments:
   -P PORT, --port PORT  SSH port to use
 ```
 
-# ssh-config
+## ssh-config
 
 Generate SSH configuration file
 
@@ -89,7 +91,7 @@ optional arguments:
   -P PORT, --port PORT  SSH port to use
 ```
 
-# ssh-proxy
+## ssh-proxy
 
 Open new SSH proxy session to instance
 
@@ -111,7 +113,7 @@ optional arguments:
   -P PORT, --port PORT  SSH port to use
 ```
 
-# list (ls)
+## list (ls)
 
 List available instances
 

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -1,4 +1,4 @@
-# Configuration file
+## Configuration file
 
 If you are often connecting to the same instances, it might be handy to store the configuration inside the configuration file,
 so you don't have to retype the same command all over again. _aws-gate_ supports storing instance connection information in a dedicated config file located at _~/.aws-gate/config_. The format of the configuration file is as follows:
@@ -30,6 +30,6 @@ aws-gate session webapp-pre
 ```
 **defaults** dictionary holds default configuration for profile and region, when these are not provided.
 
-# config.d support
+## config.d support
 
 _aws-gate_ will automatically load configuration from _~/.aws-gate/config.d_. This is especially useful is you need to share you configuration within your team or you are working on multiple projects.
diff --git a/docs/development.md b/docs/development.md
@@ -1,4 +1,4 @@
-# Debug mode
+## Debug mode
 
 _aws-gate_ is written with easy debugging in mind. To activate a debug output, just set **GATE_DEBUG** environment variable
 and on the next invocation _aws-gate_ will start producing debug output:
@@ -23,6 +23,6 @@ and on the next invocation _aws-gate_ will start producing debug output:
 ...
 ```
 
-# Reporting problems
+## Reporting problems
 
 When you run into a problem with _aws-gate_ or something is not working as described, please do not hesitate and open an issue in the project's [issue tracker](https://github.com/xen0l/aws-gate/issues).
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -1,19 +1,20 @@
-# Prerequisites
+## Prerequisites
 
 * Python 3.5+ (earlier Python 3 versions should work too)
 * session-plugin-manager from AWS
 * Up to date version of SSM Agent must be installed on EC2 instances we want to connect to
 * Proper IAM permissions for instance profile
 
-# Installation via pip
+## Installation
+### via pip
 
 _aws-gate_ is available on PyPI:
 
 ```
 pip install aws-gate
 ```
 
-## Installation via Homebrew
+### via Homebrew
 
 _aws-gate_ package is available for macOS via Homebrew:
 
@@ -22,7 +23,7 @@ brew tap xen0l/homebrew-taps
 brew install aws-gate
 ```
 
-## Installation via Docker
+### via Docker
 
 _aws-gate_ is also available as a Docker container via []Github Package Registry](https://github.com/xen0l/aws-gate/packages/):
 
@@ -43,7 +44,7 @@ docker login docker.pkg.github.com -u $YOUR_GH_USERNAME -p $GH_TOKEN
 
 **NOTE: be careful that executing this command in your shell might store your token in your shell history!**
 
-### Executing aws-gate as Docker container
+#### Executing aws-gate as Docker container
 
 When executing _aws-gate_ as Docker container, we have to pass some additional arguments, so it can find _aws-gate_ configuration as well AWS credentials/config file (~/.aws):
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,10 +1,15 @@
 site_name: aws-gate
 site_description: AWS SSM Session manager CLI client
 theme:
-    name: readthedocs
+    name: material
     highlightjs: true
     hljs_languages:
         - yaml
+    icon:
+      repo: fontawesome/brands/github
+
+repo_url: https://github.com/xen0l/aws-gate
+
 nav:
   - Introduction:
       - aws-gate: index.md

diff --git a/requirements/requirements_doc.txt b/requirements/requirements_doc.txt
@@ -1 +1,2 @@
 mkdocs==1.1.2
+mkdocs-material==6.1.7