Documentation php rendering

.editorconfig

@@ -74,3 +74,8 @@ indent_size = 4
 [*.sql]
 indent_style = tab
 indent_size = 2
+
+# Makefile
+[{Makefile,**.mk}]
+# Use tabs for indentation (Makefiles require tabs)
+indent_style = tab

.github/workflows/test-documentation.yml

@@ -0,0 +1,17 @@
+name: test documentation
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    name: documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Test if the documentation will render without warnings
+        run: |
+          mkdir -p Documentation-GENERATED-temp \
+          && docker run --rm --pull always -v $(pwd):/project \
+             ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log

Documentation/DeveloperGuide/Index.rst

@@ -141,17 +141,17 @@ https://extensions.typo3.org/extension/introduction
 **What needs to be tested:**
 
 * Creating blog posts (with and without preview image and text)
-   * Check post preview
+    * Check post preview
 * Posting comments and subscribe for new comments
-	* With and without SPAM check triggered
-	* Test field validation
-   * Test prefilling fields
+    * With and without SPAM check triggered
+    * Test field validation
+    * Test prefilling fields
 * Using the subscription manager (confirm and delete for new comment and post subscription)
 * New comment subscription
-	* Admin, subscriber opt-in and notification emails
-	* Triggered by:
-      * Frontend & backend (confirm and un-spam a comment)
-      * Edit button (BE module and core dashboard) and direct spam / confirmed toggle buttons
+    * Admin, subscriber opt-in and notification emails
+    * Triggered by:
+        * Frontend & backend (confirm and un-spam a comment)
+        * Edit button (BE module and core dashboard) and direct spam / confirmed toggle buttons
 	* Make sure mails are sent with localized links for multi language setups
 * New post subscription
 	* Subscriber opt-in (frontend) and notification emails (button in BE module)

Documentation/Installation/Full.rst

@@ -20,27 +20,31 @@ Installation process - step by step
 In this installation guide, we will override some values and make our blog more individual.
 Some steps are already described in the :ref:`Quick Installation <quick_installation>`.
 
+#.  Import and install the extension
 
-#. Import and install the extension
-	- via the extension manager
+    * via the extension manager
 
-#. Create the following pages
-	- See :ref:`Quick Installation <quick_installation>`
-	- Optional: add an RSS page (standard page) which will contain the RSS plugin
-	- Optional: add a page (standard page) for subscribing to new blog posts
+#.  Create the following pages
 
-	.. figure:: ../Images/Installation/pagestructure.png
-		:alt: Recommended page structure
+    * See :ref:`Quick Installation <quick_installation>`
+    * Optional: add an RSS page (standard page) which will contain the RSS plugin
+    * Optional: add a page (standard page) for subscribing to new blog posts
 
-#. Include static template
-	- See :ref:`Quick Installation <quick_installation>`
+    ..  figure:: ../Images/Installation/pagestructure.png
+        :class: with-shadow
+        :alt: Recommended page structure
 
-#. Add plugins to the pages
-	- See :ref:`Quick Installation <quick_installation>`
-	- Optional: add the RSS plugin to your RSS page
-	- Optional: add the Blog Subscription Form plugin to the previously created page
+#.  Include static template
 
-#. Start to configure your Blog. This is an TypoScript example:
+    * See :ref:`Quick Installation <quick_installation>`
+
+#.  Add plugins to the pages
+
+    * See :ref:`Quick Installation <quick_installation>`
+    * Optional: add the RSS plugin to your RSS page
+    * Optional: add the Blog Subscription Form plugin to the previously created page
+
+#.  Start to configure your Blog. This is an TypoScript example:
 
 .. code-block:: typoscript
 	:linenos:

Documentation/UpgradeGuide/Version-3.rst

@@ -113,16 +113,16 @@ https://github.com/fnagel/t3extblog/compare/2.0.0...3.0.0
 
 **Breaking changes**
 
-- ViewHelper changes
-	- Introduced custom `paginate` VH
-	- Removed custom `flashMessages` VH (use default one instead)
-	- Add `flashMessagesClearCache` VH in `Comment/New.html` partial (before `flashMessages` VH!)
-
-- Changed email template configuration
-	- Old `plugin.tx_t3extblog.email` configuration has been removed
-	- Use default `plugin.tx_t3extblog.view` configuration instead
-	- `Email/` is appended to the final template path when rendering emails
-	- No changes needed if default path structure has been used
+* ViewHelper changes
+    * Introduced custom `paginate` VH
+    * Removed custom `flashMessages` VH (use default one instead)
+    * Add `flashMessagesClearCache` VH in `Comment/New.html` partial (before `flashMessages` VH!)
+
+* Changed email template configuration
+    * Old `plugin.tx_t3extblog.email` configuration has been removed
+    * Use default `plugin.tx_t3extblog.view` configuration instead
+    * `Email/` is appended to the final template path when rendering emails
+    * No changes needed if default path structure has been used
 
 
 How to upgrade

Documentation/guides.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<guides xmlns="https://www.phpdoc.org/guides"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://www.phpdoc.org/guides ../vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd"
+        links-are-relative="true">
+    <extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension"
+               project-home="https://extensions.typo3.org/extension/t3extblog"
+               project-contact=""
+               project-repository="https://github.com/fnagel/t3extblog"
+               project-issues="https://github.com/fnagel/t3extblog/issues"
+               edit-on-github-branch="master"
+               edit-on-github="fnagel/t3extblog"
+               typo3-core-preferred="12.4"
+               interlink-shortcode="fnagel/t3extblog"
+    />
+    <project title="T3Extblog"
+             release="master (development)"
+             version="master (development)"
+             copyright="2024"
+    />
+</guides>

Makefile

@@ -0,0 +1,14 @@
+.PHONY: help
+help: ## Displays this list of targets with descriptions
+    @echo "The following commands are available:\n"
+    @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: docs
+docs: ## Generate projects documentation (from "Documentation" directory)
+	mkdir -p Documentation-GENERATED-temp
+	docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
+
+.PHONY: test-docs
+test-docs: ## Test the documentation rendering
+	mkdir -p Documentation-GENERATED-temp
+	docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log