Merge branch 'demo' into 'main'

feat: [demo]: Added demo for dog lovers

See merge request mwasilew/2023-ZPRP!22

Author: Mateusz Bronisław Wasilewski

Makefile

@@ -26,8 +26,12 @@ clean:
 	rm -rf .tox
 	rm -rf .hypothesis
 
-plugin_demo:
-	cd demo
+demo_cats:
+	cd demo/demo_cats
+	mkdocs serve
+
+demo_dogs:
+	cd demo/demo_dogs
 	mkdocs serve
 
 .PHONY: tests clean pre_commit

README.md

@@ -71,9 +71,5 @@ Example:
 ![MyImage]@small(../images/b.png)
 ```
 
-#### Info:
-If you accidentally use a tag that is not specified in the documentation, the tag will be removed and the image will be displayed with no additional formatting.
-
-
 ### Demo:
-You can see the plugin in action after you clone this project to your local repository by executing `make plugin_demo` in the main directory.
+You can see the plugin in action after you clone this project to your local repository. Depending on whether you're a dog or a cat person, execute `make demo_dogs` or `make demo_cats`.

demo/docs/img/Maine_coon.jpg renamed to demo/demo_cats/docs/img/Maine_coon.jpg

@@ -13,11 +13,11 @@ plugins:
   - image-formatter:
       image_size:
         small:
-          height: 100px
-          width: 100px
+          height: 250px
+          width: 250px
         big:
-          height: 200px
-          width: 200px
+          height: 500px
+          width: 500px
 
 nav:
   - Home: index.md

demo/docs/img/Persialainen.jpg renamed to demo/demo_cats/docs/img/Persialainen.jpg

@@ -0,0 +1,49 @@
+# Dogs
+
+## Introduction
+
+Dogs, often referred to as "man's best friend," are domesticated mammals known for their loyalty, companionship, and diverse breeds. Here's a glimpse into the fascinating world of dogs.
+
+## Breeds
+
+### 1. Labrador Retriever
+
+Labrador Retrievers are one of the most popular dog breeds known for their friendly nature and intelligence. They come in three colors: chocolate, black, and yellow.
+
+![Labrador Retriever]@small(./img/Labrador-retriever.jpg)
+
+### 2. German Shepherd
+
+German Shepherds are versatile and intelligent working dogs. They are known for their courage, strength, and trainability.
+
+![German Shepherd]@small(./img//german-shepherd-dog.jpeg)
+
+### 3. Beagle
+
+Beagles are small to medium-sized dogs with a keen sense of smell. They are friendly, curious, and make excellent family pets.
+
+![Beagle]@big(./img/beagle.jpg)
+
+## Behavior
+
+Dogs exhibit a wide range of behaviors that endear them to humans.
+
+### 1. Wagging Tails
+
+A wagging tail often indicates a dog's excitement or happiness. Understanding tail movements helps interpret a dog's emotions.
+
+### 2. Fetching
+
+Many dogs love to play fetch, showcasing their natural retrieval instincts. It's an excellent way to engage and exercise them.
+
+### 3. Loyalty
+
+Dogs are known for their unwavering loyalty and devotion to their owners. They form strong bonds with human companions.
+
+## Health
+
+### 1. Common Health Issues
+
+- **Hip Dysplasia:** Larger breeds may be prone to hip dysplasia. Regular exercise and a balanced diet can help prevent this.
+
+- **Dental Care:** Regular

demo/docs/img/Siam_lilacpoint.jpg renamed to demo/demo_cats/docs/img/Siam_lilacpoint.jpg

@@ -0,0 +1,23 @@
+site_name: Test with cats
+
+dev_addr: 127.0.0.1:8002
+
+theme:
+  name: "material"
+
+markdown_extensions:
+  - attr_list
+
+plugins:
+  - mkdocstrings
+  - image-formatter:
+      image_size:
+        small:
+          height: 50%
+          width: 50%
+        big:
+          height: 80%
+          width: 80%
+
+nav:
+  - Home: index.md

demo/docs/index.md renamed to demo/demo_cats/docs/index.md

@@ -68,6 +68,5 @@ Example:
 ![MyImage]@small(../images/b.png)
 ```
 
-#### Info:
-If you accidentally use a tag that is not specified in the documentation, the tag will be removed and the image will be displayed with no additional formatting.
-
+### Demo:
+You can see the plugin in action after you clone this project to your local repository. Depending on whether you're a dog or a cat person, execute `make demo_dogs` or `make demo_cats`.