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

Document how to customize page #1923

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rgaiacs
Copy link
Contributor

@rgaiacs rgaiacs commented Jan 30, 2025

Closes #1907

We might want to make add a new traitlets for users to provide their own Jinja template that will be used in

"page.html",
from
self.render_template(
"page.html",
page_config=self.page_config,
extra_footer_scripts=self.settings["extra_footer_scripts"],
opengraph_title=self.opengraph_title,
)

@rgaiacs rgaiacs requested a review from yuvipanda January 30, 2025 13:37
@rgaiacs rgaiacs self-assigned this Jan 30, 2025
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

BinderHub uses `Jinja <https://jinja.palletsprojects.com/en/stable/>`_ as template engine
to process the page template `binderhub/templates/page.html <https://github.com/jupyterhub/binderhub/blob/main/binderhub/templates/page.html>`.
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

I think it'd be helpful to also highlight the important parts of the template- is <div id="root"></div> the critical bit?

release: {{ .Release.Name }}
data:
{{- (.Files.Glob "files/*").AsConfig | nindent 2 }}

Copy link
Member

Choose a reason for hiding this comment

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

Is additional Helm configuration needed to mount the file in the ConfigMap into the BinderHub pod?

@rgaiacs
Copy link
Contributor Author

rgaiacs commented Feb 5, 2025

I will address the comments in a couple of weeks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to customise index / root page
2 participants