Simplifying base templates

UPGRADE.md

@@ -33,3 +33,7 @@ This document serves as a reference for updating your current version of the Bum
 * Class `\BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity\OnCheckIsClassEntityCanBeLoad` has been removed. Use `\BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity\OnCheckIsEntityCanBeLoaded`
 * ⚠️**PHP ReflectionAPI has been completely changed. See information about the current version here:** [ReflectionAPI](https://github.com/bumble-tech/bumble-doc-gen/tree/master/docs/tech/2.parser/reflectionApi)
 * Method `\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getComposerInstalledFile()` renamed to `\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getComposerVendorDir()`
+* Twig filter `\BumbleDocGen\Core\Renderer\Twig\Filter\TextToCodeBlock` removed
+* Twig filter `\BumbleDocGen\Core\Renderer\Twig\Filter\TextToHeading` removed
+* Plugin `\BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\PageLinkerPlugin` now generates MD instead of HTML
+* Twig function `\BumbleDocGen\Core\Renderer\Twig\Function\GeneratePageBreadcrumbs` removed. Use `\BumbleDocGen\Core\Renderer\Twig\Function\DrawPageBreadcrumbs` function instead

demo/demo1/templates/classMap/index.md.twig

@@ -1,11 +1,13 @@
 ---
 title: Class map
 ---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
 
-{{ "Class map epample" | textToHeading('H1') }}
+# Class map example
 
-{{ "{{ drawClassMap( phpEntities ) }}"  | textToCodeBlock('twig') }}
+```twig
+{{ "{{ drawClassMap( phpEntities ) }}" }}
+```
 
 **The result of the function execution:**
 

demo/demo1/templates/readme.md.twig

@@ -1,11 +1,12 @@
 ---
 title: Demo 1
 ---
-{{ "Demo 1" | textToHeading('H1') }}
+# Demo 1
 
 {{ drawDocumentationMenu() }}
 
-
 To update this documentation, run the following command:
 
-{{ 'php demo/demo1/demoScript.php' | textToCodeBlock('console') }}
+```console
+php demo/demo1/demoScript.php
+```

demo/demo1/templates/sectionWithSubsections/classListExample/index.md.twig

@@ -1,12 +1,14 @@
 ---
 title: Class list example
 ---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
 
-{{ "Class list" | textToHeading('H1') }}
+# Class list
 
 **List of classes filtered by the directory where they are located.**
 
-{{ "{{ printEntityCollectionAsList( phpEntities.filterByPaths(['/annotations']) ) }}"  | textToCodeBlock('twig') }}
+```twig
+{{ "{{ printEntityCollectionAsList( phpEntities.filterByPaths(['/annotations']) ) }}" }}
+```
 
 {{ printEntityCollectionAsList( phpEntities.filterByPaths(['/annotations']) ) }}

demo/demo1/templates/sectionWithSubsections/index.md.twig

@@ -1,11 +1,13 @@
 ---
 title: Section with subsections
 ---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
 
-{{ "Section with subsections example" | textToHeading('H1') }}
+# Section with subsections example
 
-{{ "{{ drawDocumentationMenu(_self) }}"  | textToCodeBlock('twig') }}
+```twig
+{{ "{{ drawDocumentationMenu(_self) }}" }}
+```
 
 **Documentation menu from current page only:**
 

demo/demo1/templates/sectionWithSubsections/pageLinkingExample/index.md.twig

@@ -1,9 +1,9 @@
 ---
 title: Page linking example
 ---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
 
-{{ "Page linking example" | textToHeading('H1') }}
+# Page linking example
 
 1) [a]InvalidArgumentException[/a] - create a reference by short class name
 2) [a]Doctrine\Common\Annotations\AnnotationException[/a] - creating a reference by full class name

demo/demo4-config-array/templates/README.md.twig

@@ -1,10 +1,12 @@
 ---
 title: Demo 5
 ---
-{{ "Demo 5" | textToHeading('H1') }}
+# Demo 5
 
 {{ printEntityCollectionAsList( phpEntities.filterByPaths(['/annotations']) ) }}
 
 To update this documentation, run the following command:
 
-{{ 'php demo/demo4-config-array/demoScript.php' | textToCodeBlock('console') }}
+```console
+php demo/demo4-config-array/demoScript.php
+```

docs/README.md

@@ -1,86 +1,82 @@
-<embed> <h1>BumbleDocGen: A Documentation Generator for PHP projects 🐝</h1> </embed>
+# BumbleDocGen: A Documentation Generator for PHP projects 🐝
 
-<b>BumbleDocGen</b> is a robust library for generating and maintaining documentation next to the code of large and small PHP projects.
+**BumbleDocGen** is a robust library for generating and maintaining documentation next to the code of large and small PHP projects.
 
 This tool analyzes your codebase and produces a comprehensive set of Markdown documents, including descriptions of classes, methods, and properties alongside navigable internal links.
 
-<embed> <h2>Installation</h2> </embed>
+## Installation
 
 Add the BumbleDocGen to the `composer.json` file of your project using the following command:
 
 ```console
- composer require bumble-tech/bumble-doc-gen
+composer require bumble-tech/bumble-doc-gen
 ```
 
+## Detailed technical description
 
-<embed> <h2>Detailed technical description</h2> </embed>
+💡 Please refer to the [Description of the technical part of the project](/docs/tech/readme.md) for a detailed explanation of all the classes and methods used.
 
-💡 Please refer to the <a href="/docs/tech/readme.md">Description of the technical part of the project</a> for a detailed explanation of all the classes and methods used.
+## Core Features
 
-<embed> <h2>Core Features</h2> </embed>
+1. 🔍 **[Parsing](/docs/tech/02_parser/readme.md):**
+  BumbleDocGen analyzes your code and provides a convenient [Reflection API](/docs/tech/02_parser/reflectionApi/readme.md).
 
-- 🔍 <b><a href="/docs/tech/02_parser/readme.md">Parsing</a>:</b>
-  BumbleDocGen analyzes your code and provides a convenient <a href="/docs/tech/02_parser/reflectionApi/readme.md">Reflection API</a>.
-
-- ✍️ <b><a href="/docs/tech/03_renderer/readme.md">Rendering</a>:</b>
+2. ✍️ **[Rendering](/docs/tech/03_renderer/readme.md):**
   BumbleDocGen generates markdown content using templates and fills them with data obtained from parsing your code.
 
-- 🧠 <b>AI tools for documentation generation:</b>
+3. 🧠 **AI tools for documentation generation:**
   BumbleDocGen allows you to use a group of AI tools to help generate project documentation.
 
-<embed> <h2>How to Use</h2> </embed>
+## How to Use
 
-<embed> <h3>Entry points</h3> </embed>
+### Entry points
 
-BumbleDocGen's interface consists of mainly two classes: <a href="/docs/classes/DocGenerator.md">DocGenerator</a> and <a href="/docs/classes/DocGeneratorFactory.md">DocGeneratorFactory</a>.
+BumbleDocGen's interface consists of mainly two classes: [DocGenerator](classes/DocGenerator.md) and [DocGeneratorFactory](classes/DocGeneratorFactory.md).
 
-- <a href="/docs/classes/DocGenerator.md">DocGenerator</a> provides main operations for generating the documents.
+- [DocGenerator](classes/DocGenerator.md) provides main operations for generating the documents.
 
-    - [addDocBlocks()](/docs/classes/DocGenerator.md#madddocblocks): Generate missing docBlocks with LLM for project class methods that are available for documentation
-    - [generate()](/docs/classes/DocGenerator.md#mgenerate): Generates documentation using configuration
-    - [generateReadmeTemplate()](/docs/classes/DocGenerator.md#mgeneratereadmetemplate): Creates a `README.md` template filled with basic information using LLM
-    - [serve()](/docs/classes/DocGenerator.md#mserve): Serve documentation
+    - [addDocBlocks()](classes/DocGenerator.md#madddocblocks): Generate missing docBlocks with LLM for project class methods that are available for documentation
+    - [generate()](classes/DocGenerator.md#mgenerate): Generates documentation using configuration
+    - [generateReadmeTemplate()](classes/DocGenerator.md#mgeneratereadmetemplate): Creates a `README.md` template filled with basic information using LLM
+    - [serve()](classes/DocGenerator.md#mserve): Serve documentation
 
-- <a href="/docs/classes/DocGeneratorFactory.md">DocGeneratorFactory</a> provides a method for creating `DocGenerator` instance.
+- [DocGeneratorFactory](classes/DocGeneratorFactory.md) provides a method for creating `DocGenerator` instance.
 
-    - [create()](/docs/classes/DocGeneratorFactory.md#mcreate): Creates a documentation generator instance using configuration files
-    - [createByConfigArray()](/docs/classes/DocGeneratorFactory.md#mcreatebyconfigarray): Creates a documentation generator instance using an array containing the configuration
-    - [createConfiguration()](/docs/classes/DocGeneratorFactory.md#mcreateconfiguration): Creating a project configuration instance
-    - [createRootEntitiesCollection()](/docs/classes/DocGeneratorFactory.md#mcreaterootentitiescollection): Creating a collection of entities (see `ReflectionAPI`)
+    - [create()](classes/DocGeneratorFactory.md#mcreate): Creates a documentation generator instance using configuration files
+    - [createByConfigArray()](classes/DocGeneratorFactory.md#mcreatebyconfigarray): Creates a documentation generator instance using an array containing the configuration
+    - [createConfiguration()](classes/DocGeneratorFactory.md#mcreateconfiguration): Creating a project configuration instance
+    - [createRootEntitiesCollection()](classes/DocGeneratorFactory.md#mcreaterootentitiescollection): Creating a collection of entities (see `ReflectionAPI`)
 
-<embed> <h3>Examples of usage</h3> </embed>
+### Examples of usage
 
 1) Working with a library in a PHP file
+    ```php
+    require_once 'vendor/autoload.php';
 
-```php
-require_once 'vendor/autoload.php';
-
-use BumbleDocGen\DocGeneratorFactory;
-
-// Initialize the factory
-$factory = new DocGeneratorFactory();
+    use BumbleDocGen\DocGeneratorFactory;
 
-// Create a DocGenerator instance
-$docgen = $factory->create('/path/to/configuration/files');
+    // Initialize the factory
+    $factory = new DocGeneratorFactory();
 
-// or $docgen = $factory->createByConfigArray([...]);
+    // Create a DocGenerator instance
+    $docgen = $factory->create('/path/to/configuration/files');
 
-// Now call the desired operation
-$docgen->generate();
-```
+    // or $docgen = $factory->createByConfigArray([...]);
 
+    // Now call the desired operation
+    $docgen->generate();
+    ```
 2) Working with the library through a console application
+    ```bash
+    # List of available commands
+    ./vendor/bin/bumbleDocGen list
 
-```bash
-# List of available commands
-./vendor/bin/bumbleDocGen list
-
-# Documentation generation example
-./vendor/bin/bumbleDocGen generate -c <path to config file>
+    # Documentation generation example
+    ./vendor/bin/bumbleDocGen generate -c <path to config file>
 
-# Getting detailed information about a command
-./vendor/bin/bumbleDocGen generate -h
-```
+    # Getting detailed information about a command
+    ./vendor/bin/bumbleDocGen generate -h
+    ```
 
 ------------------
 
@@ -89,11 +85,10 @@ $docgen->generate();
 To update this documentation, run the following command:
 
 ```console
- ./bin/bumbleDocGen generate
+./bin/bumbleDocGen generate
 ```
 
 
+---
 
-<div id='page_committer_info'>
-<hr>
-<b>Last page committer:</b> fshcherbanich &lt;[email protected]&gt;<br><b>Last modified date:</b>   Sat Dec 23 23:00:37 2023 +0300<br><b>Page content update date:</b> Mon Jan 15 2024<br>Made with <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md'>Bumble Documentation Generator</a></div>
+**Last page committer:** fshcherbanich &lt;[email protected]&gt;<br>**Last modified date:**   Thu Jan 18 14:38:29 2024 +0300<br>**Page content update date:** Fri Jan 19 2024<br>Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)