Make tocbot work in single page mode #426
Conversation
|
Nice! You can demo what this looks like on one of the jupyter book pages here: https://2168-137292803-gh.circle-artifacts.com/0/html_singlepage/notebooks.html#Markdown-+-notebooks I think for now it'd be most straightforward to style this so that it shows up at the top, in-line with the content below, and some styling changes to make it look more consistent with the main text (currently, it has smaller text because it's meant to be in the right sidebar). Perhaps one thing to do would be to move the empty nav block from here: https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/page/page.py#L111 to underneath the title block here: https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/page/page.py#L183 For the templates stuff - I agree at some point it makes more sense to use a template - we're using a jinja template for most of the HTML rendering, it's just the final "piecing things together" part that uses some manual string injection. If it gets too unweildy at some point we should templatize it |
| @@ -246,7 +246,7 @@ def page_html(ntbk, path_media_output=None, name=None, preprocessors=None, | |||
| html, resources = exp.from_notebook_node(ntbk, resources=output_resources) | |||
|
|
|||
| html = f""" | |||
| <main class="jupyter-page"> | |||
| <main class="jupyter-page c-textbook__content"> | |||
There was a problem hiding this comment.
this is going to create some formatting weirdness in the actual book (textbook__content is a book class):
https://deploy-preview-426--jupyter-book.netlify.com/intro
better that we:
- Pick the CSS styles that should be shared between a "book" TOC and a single page TOC, move them into a selector that is agnostic to a book-specific class
- Define a class that's specific to the single page (maybe just
class="jupyter-page single-page"?) and add some CSS rules for the one-page case
|
Closing as this should be superceded by beta.jupyterbook.org, but thanks very much for your work on this! Let me know if the TOC doesn't work with the new build system |
See discussion in #113 (comment).
The main problem was that the tocbot script was not included.
It works in principle, but arguably the layout can be improved: