Closed EssamWisam closed 7 months ago
Check out this pull request on
See visual diffs & provide feedback on Jupyter Notebooks.
Powered by ReviewNB
you also need to know the Franklin @@ magic, at least for consistency with existing tutes.
Not really. The script is there for a reason: it loops over all tutorials in the _literate folder and its idempotent. So all that one has to do after running the tutorial is to run the script (which is actually a notebook for better readibility) and the collpase feature will automatically be introduced.
Not only do you need familiarity with markdown and Literate.jl's formatting of markdown
I like that this a concern even if negligble/conditional. This is why I like notebooks more; they are converted to markdown in a single command and are absolutely readable.
Not really. The script is there for a reason: it loops over all tutorials in the _literate folder and its idempotent. So all that one has to do after running the tutorial is to run the script (which is actually a notebook for better readibility) and the collpase feature will automatically be introduced.
Got it. Can you add instructions in the README.md that explicate this extra step for a maintainer.
This PR makes use of Franklin's @@ feature and JavaScript to allow markdown files to have collapsable sections. Given any sequence of markdown elements of length two that take the form:
Introducing the feature is possible by wrapping the sections with
@@
accordingly:The resulting UI will make it possible to use the heading/list item to show or collapse the markdown in dropdown-content. This is used in the sidebar and all tutorials.
Thanks for this nice package. Absolutely deserves much wider recognition.