[FEATURE] Make templates overridable#1190
Open
CybotTM wants to merge 3 commits into
Open
Conversation
Member
|
@kaystrobach would this solution work for you? |
|
Good from reading. Only question left is how to add own logos / css etc. we can do this after rendering with cp but this feels „hacky“ using the resources folder feels more natural for that. That would be the only missing point from my POV. removing leftovers files is more a task for external cleanup (should not be done in the container) |
CybotTM
force-pushed
the
feature/overridable-templates
branch
from
52c03ca to
a3ee246
Compare
CybotTM
force-pushed
the
feature/overridable-templates
branch
from
a3ee246 to
2495f38
Compare
CybotTM
force-pushed
the
feature/overridable-templates
branch
from
2495f38 to
3f39239
Compare
Contributor
Author
|
We can do the asset copy in this PR or in a follow-up ... your call @linawolf |
Allow users to override Twig templates when rendering documentation locally via Docker or a custom CI pipeline, without modifying the container image. Two override methods are supported: 1. Docker volume mount at ``/templates`` (highest priority) 2. Project-bundled templates at ``resources/custom-templates`` The theme extension detects these directories and prepends them to the template search path, so custom templates take precedence over the built-in theme templates. Continues the work from TYPO3-Documentation#1085 by @linawolf. Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
- Add :caption: to every code-block in the Templating page - Replace the four-row list-table of container paths with a description list, so file paths fit under 80 chars - Rewrite the shell copy examples to use TMPL / SRC variables, bringing the shell lines under 80 chars and letting the same variable drive both source and target paths One ``:file:`` line stays at 82 chars because the ``guides-restructured-text`` path is 70 chars on its own and the ``:file:`` role cannot be broken across lines. Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
CybotTM
force-pushed
the
feature/overridable-templates
branch
from
c30e6d9 to
71df316
Compare
|
Thank you |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Lets you override the theme's Twig templates without rebuilding the container, useful for local rendering and custom CI pipelines.
Two override directories are checked, both prepended to the Twig search path so they win over the built-in templates:
/templates— mounted via Docker volume (highest priority)resources/custom-templates— bundled in the project repoTemplates rendered by the central docs.typo3.org pipeline are unaffected: that runs a fixed image and never sees these directories.
Continues #1085 by @linawolf, picking up the path and entrypoint fixes discussed there with @jaapio and @kaystrobach.