use mkdocs-terminal theme (#32)

* docs from mkdocs-terminal example

* enable revision date plugin

* replace existing content with lorem ipsum text

* update default extensions

* update page headings

* remove reference to test coverage

* update copyright in license

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 ntno
+Copyright (c) 2022-2023 Natan Organick
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/about/contributing.md

@@ -0,0 +1,3 @@
+# How to Contribute
+
+Tation cotidieque intellegebat ea mei, pri cu purto scripta nusquam, an his mundi commune vivendum. Nibh decore suavitate ex has, case bonorum ne vel. Ex legere facilis nominati pri, et tota illum persecuti mea, vim elit solum ad. Per eu nihil invidunt. Duo in nusquam fierent efficiendi.

docs/about/index.md

@@ -0,0 +1,5 @@
+# About This Project
+
+Mea at iuvaret fabulas, qui facer solet vocent in. No his sumo dolor doming. At commodo invidunt cum, quem constituto comprehensam vis ut. Cu elit ridens fabulas mei. Id per prima option labores. Pri at principes laboramus, est ex diceret singulis sadipscing.
+
+Nam aeterno constituto id, affert noster no ius. Cum te moderatius definiebas elaboraret. Ad quo adipisci hendrerit reprimique, id vim vitae scribentur. Ipsum viris senserit vis ad, eum eu sumo dico appellantur. Ipsum aliquam an mea, mutat zril exerci mel cu, quem labitur definitiones pri et. Clita vitae rationibus quo et, novum accusata sit an.

docs/about/license.md

@@ -0,0 +1,5 @@
+# License
+
+Proin quis velit eget enim bibendum viverra.
+Nunc sed urna vel ligula gravida blandit.
+Phasellus a elit interdum, mollis lorem nec, elementum nisi.

docs/about/release-notes/index.md

@@ -0,0 +1,6 @@
+# Release Notes
+
+| Release            | Supported? |
+| ------------------ | ---------- |
+| [v2](version-2.md) | yes        |
+| [v1](version-1.md) | no         |

docs/about/release-notes/version-1.md

@@ -0,0 +1,8 @@
+# Version 1
+
+Information about Version 1 release here
+
+## Updates
+
+- Aliquam rhoncus nibh nec nisi elementum tincidunt at eget arcu.
+- Vestibulum sit amet leo sed magna dictum semper.

docs/about/release-notes/version-2.md

@@ -0,0 +1,8 @@
+# Version 2
+
+Information about Version 2 release here
+
+## Updates
+
+- Curabitur ac arcu ut erat porttitor elementum.
+- Nulla vitae odio bibendum, rutrum felis vitae, maximus dolor.

docs/help.md

@@ -0,0 +1,20 @@
+# Common Errors
+
+Fusce vestibulum ullamcorper justo eget faucibus. Proin vel dictum erat, vitae interdum nisl. Ut sodales sagittis elit, vel sodales lacus ullamcorper sed.  Sed vel congue nibh. 
+
+## ERR_1
+Morbi varius velit libero, eu. 
+
+> Vivamus eget massa eu odio ornare pretium et a mi.  Ut sed pulvinar metus. Aliquam erat volutpat. Proin imperdiet rutrum dui, et accumsan mi fringilla vel.
+
+Morbi vitae elit sapien. Cras malesuada iaculis dolor, ac tempus nulla varius nec. Maecenas sed arcu enim.
+
+## ERR_2
+Suspendisse semper, risus id consectetur. 
+
+## ERR_3
+Ut pellentesque egestas est et. 
+
+```
+Suspendisse commodo, leo id facilisis pellentesque, lectus nunc interdum quam, et blandit elit elit sit amet leo.
+```

docs/img/picsum/info.json

@@ -0,0 +1,89 @@
+[{
+        "id": "167",
+        "author": "petradr",
+        "width": 2896,
+        "height": 1944,
+        "url": "https://unsplash.com/photos/WqK_xV_hbug",
+        "download_url": "https://picsum.photos/id/167/2896/1944"
+    },
+    {
+        "id": "127",
+        "author": "Marcin Czerwinski",
+        "width": 4032,
+        "height": 2272,
+        "url": "https://unsplash.com/photos/rf-0DQu5M6Y",
+        "download_url": "https://picsum.photos/id/127/4032/2272"
+    },
+    {
+        "id": "143",
+        "author": "Steve Richey",
+        "width": 3600,
+        "height": 2385,
+        "url": "https://unsplash.com/photos/6xqAK6oAeHA",
+        "download_url": "https://picsum.photos/id/143/3600/2385"
+    },
+    {
+        "id": "120",
+        "author": "Guillaume",
+        "width": 4928,
+        "height": 3264,
+        "url": "https://unsplash.com/photos/_DA3D5P71qs",
+        "download_url": "https://picsum.photos/id/120/4928/3264"
+    },
+    {
+        "id": "115",
+        "author": "Christian Hebell",
+        "width": 1500,
+        "height": 1000,
+        "url": "https://unsplash.com/photos/A6S-q3D67Ss",
+        "download_url": "https://picsum.photos/id/115/1500/1000"
+    },
+    {
+        "id": "149",
+        "author": "Guillaume",
+        "width": 3454,
+        "height": 2288,
+        "url": "https://unsplash.com/photos/revxuIor0nY",
+        "download_url": "https://picsum.photos/id/149/3454/2288"
+    },
+    {
+        "id": "166",
+        "author": "Romain Briaux",
+        "width": 1280,
+        "height": 720,
+        "url": "https://unsplash.com/photos/yD3PXDV7Sjc",
+        "download_url": "https://picsum.photos/id/166/1280/720"
+    },
+    {
+        "id": "167",
+        "author": "petradr",
+        "width": 2896,
+        "height": 1944,
+        "url": "https://unsplash.com/photos/WqK_xV_hbug",
+        "download_url": "https://picsum.photos/id/167/2896/1944"
+    },
+    {
+        "id": "121",
+        "author": "Radio Pink",
+        "width": 1600,
+        "height": 1067,
+        "url": "https://unsplash.com/photos/p-bkdO43shE",
+        "download_url": "https://picsum.photos/id/121/1600/1067"
+    },
+    {
+        "id": "109",
+        "author": "Zwaddi",
+        "width": 4287,
+        "height": 2392,
+        "url": "https://unsplash.com/photos/YvYBOSiBJE8",
+        "download_url": "https://picsum.photos/id/109/4287/2392"
+    },
+    {
+        "id": "102",
+        "author": "Ben Moore",
+        "width": 4320,
+        "height": 3240,
+        "url": "https://unsplash.com/photos/pJILiyPdrXI",
+        "download_url": "https://picsum.photos/id/102/4320/3240"
+    }
+]

docs/index.md

@@ -1,12 +1,5 @@
----
----
-
 # {{ GREETING }} {{ NAME }} !!!
 
-[this is a link](https://github.com/ntno/mkdocs-demo)  
-
-[this link opens in a new tab](https://github.com/ntno/mkdocs-demo){target="_blank"}
-
 this is **bold** text
 
 this is _italics_

docs/macros-test.md

@@ -0,0 +1 @@
+{{ macros_info() }}

docs/user-guide/configuration.md

@@ -0,0 +1,3 @@
+# Configuration
+
+Maecenas gravida tellus eu volutpat blandit. Nullam at mi odio. Nunc suscipit venenatis tellus et suscipit. Sed aliquet luctus mi, quis rhoncus urna placerat iaculis. Donec scelerisque ultrices risus, ut iaculis orci fermentum eu. Nam pretium justo justo, vel eleifend neque ultricies malesuada. Duis egestas orci nec sagittis rutrum. 

docs/user-guide/custom-themes.md

@@ -0,0 +1,5 @@
+# Custom Themes
+
+Pellentesque elementum velit sapien, at eleifend sem tristique ac. Aliquam a dictum sapien. Sed blandit, eros eu consectetur mattis, urna dolor rutrum neque, nec pharetra magna tortor nec ante. Donec tellus velit, malesuada et mi sed, volutpat bibendum nunc. Sed consectetur nec nisl in congue. Duis ultrices elit ut urna vestibulum mollis. 
+
+Praesent convallis augue in tempor elementum. Mauris suscipit condimentum augue ut elementum. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Etiam ac nisl ut libero malesuada pretium. 

docs/user-guide/deploying-your-docs.md

@@ -0,0 +1,3 @@
+# Deploying Your Documentation
+
+Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Quisque aliquet nisi vitae orci auctor, ullamcorper convallis risus dapibus. Morbi pretium blandit nisl at eleifend. Nam finibus augue lorem, non pharetra ipsum vulputate at. Etiam sollicitudin orci et purus pulvinar, convallis feugiat ipsum porta. 

docs/user-guide/styling-your-docs.md

@@ -0,0 +1,3 @@
+# Styling Your Documentation
+
+Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Proin a orci ac lacus elementum volutpat. Mauris sit amet mauris dictum, ornare mi nec, vehicula dolor. Sed dapibus bibendum tellus, sed posuere erat porta sit amet. Sed eu commodo mauris. Sed id sem ante. Cras viverra facilisis sem, a cursus lectus dignissim ac. 

docs/user-guide/writing-your-docs.md

@@ -0,0 +1,3 @@
+# Writing Your Documentation
+
+Quisque fringilla orci nisl, quis hendrerit eros tincidunt vitae. Aliquam dictum mi tortor, vitae egestas felis posuere facilisis. Proin lorem ex, consequat vitae sollicitudin non, ultricies fermentum neque. Mauris vitae nunc at metus dignissim rhoncus. 

mkdocs.yml

@@ -1,41 +1,61 @@
 site_name: mkdocs-demo
 site_author: ntno
+repo_url: https://github.com/ntno/mkdocs-demo
+edit_uri: edit/main/docs/
+copyright: Copyright 2023 Natan Organick, All rights reserved
 
 nav:
     - Home: 'index.md'
+    - Troubleshooting: 'help.md'
+    - About: 
+      - Index: 'about/index.md'
+      - Contributing: 'about/contributing.md'
+      - License: 'about/license.md'
+      - Release Notes:
+        - Index: 'about/release-notes/index.md'
+        - v1: 'about/release-notes/version-1.md'
+        - v2: 'about/release-notes/version-2.md'
+    - User Guide:
+      - Configuration: 'user-guide/configuration.md'
+      - Custom Themes: 'user-guide/custom-themes.md'
+      - Deployment: 'user-guide/deploying-your-docs.md'
+      - Styling: 'user-guide/styling-your-docs.md'
+      - Writing: 'user-guide/writing-your-docs.md'
+
 
 markdown_extensions:
-  - abbr
-  - admonition
+  # Python Markdown  
   - attr_list
+  - def_list
+  - footnotes
   - md_in_html
   - meta
-  - pymdownx.details
-  - pymdownx.snippets
-  - pymdownx.superfences
-  - pymdownx.tabbed
-  - pymdownx.tasklist:
-      custom_checkbox: true
   - toc:
-      permalink: true
+      permalink: "#"
+      permalink_title: Anchor link to this section for reference
+
+  # PyMdown Extensions
+  - pymdownx.caret
+  - pymdownx.mark
+  - pymdownx.tilde
+  - pymdownx.snippets:
+      base_path: 
+        - docs
 
 theme:
-  name: material
+  name: terminal
   features:
-    - navigation.tabs
-    - navigation.tabs.sticky
-    - navigation.sections
-    - toc.integrate
-  palette:
-    primary: light-green
-    accent: amber
+    - navigation.side.indexes
+    - revision.date
+    - revision.history
   static_templates:
     - 404.html
 
 plugins:
   - search
   - markdown-filter
   - macros
+  - git-revision-date
 
 extra:
   GREETING: !ENV [GREETING]

requirements.txt

@@ -1,5 +1,10 @@
 mkdocs
-mkdocs-material
+mkdocs-terminal
+
+# Markdown Extensions
 pymdown-extensions
+
+# MkDocs Plugins
+mkdocs-git-revision-date-plugin
 mkdocs-markdown-filter
 mkdocs-macros-plugin