Update enricher docs

README.md

@@ -22,9 +22,11 @@ It´s a thin layer around [phpdocumentor/reflection](https://github.com/phpDocum
 ## Runtime Requirements
 
 * PHP ^7.4
-* optional
-  * json extension to enrich `phploc`
-  * simplexml extension to enrich `clover` coverage data
+
+Suggested:
+
+* json extension to enrich `phploc` data
+* simplexml extension to enrich `clover` coverage data
 
 ## Quick Start
 

docs/enrichers.md

@@ -2,12 +2,18 @@
 
 ## How do they work?
 
-Enrichers can add extra data to any data holder like `Project` or `Element` items (File, Class, Interface, Trait, Method, Function, Constants and Function/Method Arguments).
-
-* Each Enricher must implement `Klitsche\Dog\Enrichers\EnricherInterface`
-* Recommendation: for a customized enricher extend the abstract class `Klitsche\Dog\Enrichers\Enricher`
-* Data holders must implement `Klitsche\Dog\Enrichers\DataAwareInterface`
-* This extra data can be scalar values or objects
+Enrichers can add extra data to a data holder. Supported data holders are:
+
+* `Project`
+* `File`
+* `Class_`
+* `Trait_`
+* `Interface_`
+* `Constant`
+* `Property`
+* `Method`
+* `Function_`
+* `Argument` 
 
 Enrichers come with a 3 phase process:
 
@@ -30,7 +36,7 @@ In this Phase enricher can add data be calling `setData(string $id, $value)` on
 Using the enricher id here is best practise.
 
 !!! Note
-    All enricher first visit the project and then all enricher visit the elements. 
+    All enricher first visit the project and then the elements. 
 
 ## Access Data in Templates
 
@@ -93,4 +99,12 @@ enrichers:
     file: phploc.json
 ```
 
-See  for more details on phploc.
+See  for more details on phploc.
+
+## Custom enricher
+
+* A Enricher must implement `Klitsche\Dog\Enrichers\EnricherInterface`
+* Best practise: enricher extends the abstract class `Klitsche\Dog\Enrichers\Enricher`
+* Data holders must implement `Klitsche\Dog\Enrichers\DataAwareInterface`
+* Best practise: use its enricher id to add extra data to data holders
+* Extra data can be scalar values or objects

mkdocs.yml

@@ -23,6 +23,7 @@ markdown_extensions:
   - footnotes
   - meta
   - smarty
+  - attr_list
   - toc:
       permalink: true
   - pymdownx.arithmatex
@@ -32,7 +33,8 @@ markdown_extensions:
   - pymdownx.critic
   - pymdownx.details
   - pymdownx.emoji:
-      emoji_generator: !!python/name:pymdownx.emoji.to_svg
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
   - pymdownx.highlight:
       # fixes copy paste support
       css_class: codehilite