Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

split table of contents from pod and style statically #2973

Merged
merged 3 commits into from
Jan 30, 2024

Conversation

haarg
Copy link
Member

@haarg haarg commented Jan 17, 2024

This separates the table of contents from the rest of the pod in the perl code, allowing it to be handled separately in the template. Includes some refactoring to do more work in the API modules.

Fixes #2972

haarg added 3 commits January 20, 2024 10:03
Rather than calculate the documented name, associated module, and
associated pod file in the controller, do it in the API.

Currently, this relies on the requested pod file to calculate, which it
probably shouldn't. But preserve the behavior and pass along the
requested name to be used in the calculation.
Create a Pod API module that fetches HTML for Pod and filters it.
Convert the Pod and Pod2HTML controllers to use it.
Split the index from the rest of the pod content, allowing it to be
templated differently. This allows its markup to be included with the
static content, rather than being assembled in javascript.

This should make it easier to format it differently in the future, and
should also fix the scroll position changing on page load.
@haarg haarg force-pushed the haarg/split-index branch from d72eb24 to ae763a5 Compare January 20, 2024 10:51
@haarg haarg requested a review from oalders January 29, 2024 04:51
Copy link
Member

@oalders oalders left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻 👍🏻 👍🏻

@oalders oalders merged commit b354b32 into master Jan 30, 2024
6 checks passed
@oalders oalders deleted the haarg/split-index branch January 30, 2024 03:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

clicking a link targetting an internal link on another page displays the target briefly then scrolls away
2 participants