updated docs

- added banner images
sugatoray · Jan 6, 2022 · bc25ea2 · bc25ea2
1 parent 211272f
commit bc25ea2
Show file tree

Hide file tree

Showing 13 changed files with 15 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # GeneSpeak
 
+![genespeak-banner](docs/assets/images/genespeak_banner_01.png)
+
 <!--- BADGES: START --->
 [![GitHub - License](https://img.shields.io/github/license/sugatoray/genespeak?logo=github&style=flat&color=green)][#github-license]
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/genespeak?logo=pypi&style=flat&color=blue)][#pypi-package]

diff --git a/docs/assets/images/genespeak_banner_01.png b/docs/assets/images/genespeak_banner_01.png
diff --git a/docs/assets/images/genespeak_banner_02.png b/docs/assets/images/genespeak_banner_02.png
diff --git a/docs/assets/images/genespeak_banner_03.png b/docs/assets/images/genespeak_banner_03.png
diff --git a/docs/assets/images/genespeak_banner_04.png b/docs/assets/images/genespeak_banner_04.png
diff --git a/docs/assets/images/genespeak_banner_05.png b/docs/assets/images/genespeak_banner_05.png
diff --git a/docs/assets/images/genespeak_banner_06.png b/docs/assets/images/genespeak_banner_06.png
diff --git a/docs/assets/images/genespeak_banner_07.png b/docs/assets/images/genespeak_banner_07.png
diff --git a/docs/assets/images/genespeak_banner_08.png b/docs/assets/images/genespeak_banner_08.png
diff --git a/docs/assets/images/genespeak_banner_09.png b/docs/assets/images/genespeak_banner_09.png
diff --git a/docs/assets/images/genespeak_logo.png b/docs/assets/images/genespeak_logo.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,12 @@
 ---
-package_version: 0.0.5
+# package:
+#     version: 0.0.5
+#     banner:
+#         path: assets/images/genespeak_banner_01.png
 ---
 
+![genespeak-banner]({{ variables.package.banner.path }})
+
 # **GeneSpeak**
 
 A library to encode text as DNA and decode DNA to text.
@@ -71,7 +76,7 @@ print(f'Text: {text}\nEncoded DNA: {dna}\nDecoded Text: {text_from_dna}\n')
 **Output**
 
 ```sh
-genespeak version: {{ package_version }}
+genespeak version: {{ variables.package.version }}
 
 Text: Hello World!
 Encoded DNA: TACATCTTTCGATCGATCGGACAATTTGTCGGTGACTCGATCTAACAT

diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -2,7 +2,7 @@
 
 ### Project Information
 site_name: genespeak
-site_description: genespeak - A library to encode text as RNA and decode RNA to text
+site_description: genespeak - A library to encode text as DNA and decode DNA to text
 site_url: https://sugatoray.github.io/genespeak/
 site_author: Sugato Ray
 
@@ -301,6 +301,11 @@ extra:
   alternate:
   - link: /
     name: en - English
+  variables:
+    package:
+      version: 0.0.5
+      banner:
+          path: assets/images/genespeak_banner_01.png
 
 extra_css:
   ## for: termynal (terminal animation)