Releases: TYPO3-Documentation/render-guides
0.35.1 - QOL changes for Live Documentation
What's Changed
Main change is a bump of the phpdocumentor/dev-server package for live documentation rendering.
- [TASK]: Bump vite from 7.1.12 to 7.2.0 in /packages/typo3-docs-theme by @dependabot[bot] in #1094
- [TASK]: Bump grunt-sass from 4.0.0 to 4.0.1 in /packages/typo3-docs-theme by @dependabot[bot] in #1095
- [TASK]: Bump vite from 7.2.0 to 7.2.1 in /packages/typo3-docs-theme by @dependabot[bot] in #1096
- [TASK]: Bump friendsofphp/php-cs-fixer from 3.89.0 to 3.89.2 by @dependabot[bot] in #1097
- [TASK]: Bump vite from 7.2.1 to 7.2.2 in /packages/typo3-docs-theme by @dependabot[bot] in #1098
- [TASK]: Bump sass from 1.93.3 to 1.94.0 in /packages/typo3-docs-theme by @dependabot[bot] in #1100
- [TASK]: Bump @vitejs/plugin-react from 5.1.0 to 5.1.1 in /packages/typo3-docs-theme by @dependabot[bot] in #1101
- [TASK] bump guides by @jaapio in #1102
Full Changelog: 0.35.0...0.35.1
0.35.0
In this release, we’ve added a new feature that changes the way you work with render-guides, making it feel like editing documentation in a what-you-see-is-what-you-get (WYSIWYG) editor.
File watcher feature is optional and will only be enabled when your add the new --watch argument to the execution of render-guides. This way you can still continue to use the tool like you did before.
🪶 File Watcher
The new watch feature automatically detects changes in your documentation and re-renders the updated files.
If you’re using the integrated development server built into the application, your browser will automatically refresh once rendering is complete.
All of this happens within seconds, greatly shortening the feedback loop when editing your documentation. Get started in our docs to learn more about live rendering.
🧰 New Tooling Integration
Since render-guides now runs in a container, you can easily integrate it as a service in your Docker Compose setup.
For those using DDEV, an add-on is available to make integration seamless.
⚡ Performance Improvements
To make working with render-guides even smoother, we’ve implemented several performance optimizations.
While the individual changes are small, the overall impact is noticeable, documentation processing is now about 30% faster than before.
📈 Other change
- [BUGFIX] Remove additional non breaking space from interlink modal by @linawolf in #1063
- [BUGFIX] Remove duplicated admonition titles by @linawolf in #1062
- [TASK] Fix local rendering in ddev by @ineswillenbrock in #1073
- [TASK] Move Permalink in link reference modal to top by @linawolf in #1083
- [BUGFIX] Reuse short links in link reference modal by @linawolf in #1066
- [BUGFIX] Allow the slash in composer name interlinks to be replaced b… by @linawolf in #1070
- [TASK] Overwrite run command by @jaapio in #1054
Full Changelog: 0.34.0...0.35.0
0.34.0
What's Changed
- [BUGFIX] Downgrade symplify/monorepo-builder to ^11.2 by @linawolf in #1050
- [TASK]: Bump friendsofphp/php-cs-fixer from 3.87.1 to 3.87.2 by @dependabot[bot] in #1051
- [TASK] only merge dependabot minor and patch versions by @jaapio in #1053
- [BUGFIX] Revert to Fontawesome 6 and fix anchor overlays by @linawolf in #1056
- [TASK]: Bump @vitejs/plugin-react from 5.0.2 to 5.0.3 in /packages/typo3-docs-theme by @dependabot[bot] in #1059
- [TASK]: Bump vite from 7.1.5 to 7.1.6 in /packages/typo3-docs-theme by @dependabot[bot] in #1061
- [BUGFIX] Fix Fontawsome header link by @linawolf in #1058
- [TASK] Add Policy Guide for Permalinks by @linawolf in #1057
Full Changelog: 0.32.0...0.34.0
Re-Release with proper tag
0.31 was an accidental release with improper semver versioning, this should now be properly tagged.
0.31
What's Changed
- [TASK] workflow maintenance by @jaapio in #998
- [TASK]: Bump friendsofphp/php-cs-fixer from 3.75.0 to 3.76.0 by @dependabot[bot] in #1000
- [TASK]: Bump vite from 7.0.0 to 7.0.1 in /packages/typo3-docs-theme by @dependabot[bot] in #1001
- [TASK]: Bump stylelint from 16.21.0 to 16.21.1 in /packages/typo3-docs-theme by @dependabot[bot] in #1002
- [TASK]: Bump vite from 7.0.1 to 7.0.2 in /packages/typo3-docs-theme by @dependabot[bot] in #1003
- [TASK]: Bump friendsofphp/php-cs-fixer from 3.76.0 to 3.80.0 by @dependabot[bot] in #1004
- [TASK]: Bump vite from 7.0.2 to 7.0.3 in /packages/typo3-docs-theme by @dependabot[bot] in #1005
- [TASK]: Bump friendsofphp/php-cs-fixer from 3.80.0 to 3.82.1 by @dependabot[bot] in #1006
- [TASK]: Bump friendsofphp/php-cs-fixer from 3.82.1 to 3.82.2 by @dependabot[bot] in #1007
- [TASK]: Bump vite from 7.0.3 to 7.0.4 in /packages/typo3-docs-theme by @dependabot[bot] in #1008
- [TASK]: Bump symplify/monorepo-builder from 11.2.22 to 11.2.23 by @dependabot[bot] in #1009
- [TASK]: Bump friendsofphp/php-cs-fixer from 3.82.2 to 3.83.0 by @dependabot[bot] in #1010
- [TASK]: Bump friendsofphp/php-cs-fixer from 3.83.0 to 3.84.0 by @dependabot[bot] in #1011
- [TASK]: Bump vite from 7.0.4 to 7.0.5 in /packages/typo3-docs-theme by @dependabot[bot] in #1013
- [TASK]: Bump stylelint from 16.21.1 to 16.22.0 in /packages/typo3-docs-theme by @dependabot[bot] in #1014
- [TASK]: Bump @vitejs/plugin-react from 4.6.0 to 4.7.0 in /packages/typo3-docs-theme by @dependabot[bot] in #1015
- Document how to create redirects by @linawolf in #1012
- [TASK]: Bump @fortawesome/fontawesome-free from 6.7.2 to 7.0.0 in /packages/typo3-docs-theme by @dependabot[bot] in #1016
- [TASK]: Bump vite from 7.0.5 to 7.0.6 in /packages/typo3-docs-theme by @dependabot[bot] in #1017
- [TASK]: Bump react from 19.1.0 to 19.1.1 in /packages/typo3-docs-theme by @dependabot[bot] in #1018
- [TASK]: Bump stylelint from 16.22.0 to 16.23.0 in /packages/typo3-docs-theme by @dependabot[bot] in #1020
- [TASK]: Bump react-dom from 19.1.0 to 19.1.1 in /packages/typo3-docs-theme by @dependabot[bot] in #1019
- [TASK]: Bump friendsofphp/php-cs-fixer from 3.84.0 to 3.85.1 by @dependabot[bot] in #1021
- [TASK]: Bump sass from 1.89.2 to 1.90.0 in /packages/typo3-docs-theme by @dependabot[bot] in #1022
- [TASK]: Bump symplify/monorepo-builder from 11.2.23 to 12.0.2 by @dependabot[bot] in #1023
- [TASK]: Bump @vitejs/plugin-react from 4.7.0 to 5.0.0 in /packages/typo3-docs-theme by @dependabot[bot] in #1024
- [TASK]: Bump vite from 7.0.6 to 7.1.0 in /packages/typo3-docs-theme by @dependabot[bot] in #1025
- [TASK]: Bump stylelint from 16.23.0 to 16.23.1 in /packages/typo3-docs-theme by @dependabot[bot] in #1026
- [TASK]: Bump vite from 7.1.0 to 7.1.1 in /packages/typo3-docs-theme by @dependabot[bot] in #1027
- [TASK]: Bump vite from 7.1.1 to 7.1.2 in /packages/typo3-docs-theme by @dependabot[bot] in #1028
- [TASK]: Bump friendsofphp/php-cs-fixer from 3.85.1 to 3.86.0 by @dependabot[bot] in #1029
- [TASK]: Bump vite from 7.1.2 to 7.1.3 in /packages/typo3-docs-theme by @dependabot[bot] in #1032
- [TASK]: Bump sass from 1.90.0 to 1.91.0 in /packages/typo3-docs-theme by @dependabot[bot] in #1034
- [TASK]: Bump bootstrap from 5.3.7 to 5.3.8 in /packages/typo3-docs-theme by @dependabot[bot] in #1035
- [BUGFIX] Typo inside the aria role of the all documentation menu by @ineswillenbrock in #1033
- [TASK]: Bump @vitejs/plugin-react from 5.0.0 to 5.0.2 in /packages/typo3-docs-theme by @dependabot[bot] in #1036
- [TASK]: Bump ergebnis/composer-normalize from 2.47.0 to 2.48.1 by @dependabot[bot] in #1039
- [TASK]: Bump vite from 7.1.3 to 7.1.4 in /packages/typo3-docs-theme by @dependabot[bot] in #1040
- [TASK]: Bump friendsofphp/php-cs-fixer from 3.86.0 to 3.87.1 by @dependabot[bot] in #1042
- [TASK]: Bump @fortawesome/fontawesome-free from 7.0.0 to 7.0.1 in /packages/typo3-docs-theme by @dependabot[bot] in #1043
- [TASK]: Bump sass from 1.91.0 to 1.92.0 in /packages/typo3-docs-theme by @dependabot[bot] in #1044
- [TASK] Migrate to Font Awesome 7 after to fix issue #1038 by @ineswillenbrock in #1045
New Contributors
- @ineswillenbrock made their first contribution in #1033
Full Changelog: 0.30.4...0.31
0.33.0: Revert to 0.30.4 state
What's Changed
The recent release had a major bug which prevented showing the anchor link modal popup which is vital for the docs.
For now we roll-back the release.