Upgrade docsy to 0.12.0 #2160
Draft
Upgrade docsy to 0.12.0 #2160
Conversation
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
Docsy 0.12.0 requires at least Hugo 0.146.0 because of changes to template paths. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
A big change for template paths landed in Hugo 0.146.0. In `layouts`, we: - remove `_default` and move everything in it directly under `layouts` - rename `partials` and `shortcodes` to `_partials` and `_shortcodes` - adapt to Hugo and docsy changes about the render-heading hook. We don't need a copy of the heading self-link template now that it is defined as a partial. - update `docs/baseof.html` to match a change upstream - split `docs/changelog.html` because it doesn't work for the section page anymore. We create a `changelog-index` layout for this. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
|
This needs to be updated after merging matrix-org/docsy#6. Marking this as a draft for now, so it is not merged in its current state. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Based on matrix-org/docsy#6.
The main reason for the changes here is to adapt to the new template system introduced in Hugo 0.146.0.
In
layouts, we:_defaultand move everything in it directly underlayoutspartialsandshortcodesto_partialsand_shortcodesdocs/baseof.htmlto match a change upstreamdocs/changelog.htmlbecause it isn't used for the section page anymore. We create achangelog-indexlayout for this.Nothing stood out to me as a change in the rendered spec.
Closes #2084.
Pull Request Checklist
Preview: https://pr2160--matrix-spec-previews.netlify.app