Skip to content

Commit

Permalink
[DOCS] Switch changelog documentation to PHP-based rendering
Browse files Browse the repository at this point in the history
You can try out the rendering locally with

```
cd typo3/sysext/core
docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
```

Resolves: #103484
Releases: main
Change-Id: I3e0645fd8e0d27afeb9857945da444520b416a7e
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/83588
Tested-by: core-ci <typo3@b13.com>
Tested-by: Benni Mack <benni@typo3.org>
Reviewed-by: Lina Wolf <112@linawolf.de>
Reviewed-by: Benni Mack <benni@typo3.org>
Reviewed-by: Garvin Hicking <gh@faktor-e.de>
Tested-by: Lina Wolf <112@linawolf.de>
  • Loading branch information
linawolf committed Mar 26, 2024
1 parent b2a9b9b commit 95fdf47
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 100 deletions.
36 changes: 1 addition & 35 deletions typo3/sysext/core/Documentation/Includes.rst.txt
@@ -1,35 +1 @@
.. More information about this file:
https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt
.. ----------
.. text roles
.. ----------
.. role:: aspect(emphasis)
.. role:: bash(code)
.. role:: css(code)
.. role:: html(code)
.. role:: js(code)
.. role:: php(code)
.. role:: rst(code)
.. role:: sep(strong)
.. role:: sql(code)

.. role:: tsconfig(code)
:class: typoscript

.. role:: typoscript(code)
.. role:: xml(code)
:class: html

.. role:: yaml(code)

.. default-role:: code

.. ---------
.. highlight
.. ---------
.. By default, code blocks use PHP syntax highlighting
.. highlight:: php
.. You can put central messages to display on all pages here
65 changes: 0 additions & 65 deletions typo3/sysext/core/Documentation/Settings.cfg

This file was deleted.

23 changes: 23 additions & 0 deletions typo3/sysext/core/Documentation/guides.xml
@@ -0,0 +1,23 @@
<?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"
max-menu-depth="2"
>
<extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension"
project-home="https://extensions.typo3.org/extension/core/"
project-contact="https://typo3.slack.com/archives/C025BQLFA"
project-repository="https://github.com/typo3/typo3"
project-issues="https://forge.typo3.org/projects/typo3cms-core/issues"
edit-on-github-branch="main"
edit-on-github="typo3/typo3"
edit-on-github-directory="typo3/sysext/core/Documentation/"
typo3-core-preferred="main"
interlink-shortcode="changelog"
/>
<project title="Core"
release="main (development)"
version="main (development)"
copyright="since 1997 by the TYPO3 contributors"
/>
</guides>

0 comments on commit 95fdf47

Please sign in to comment.