Docs: Added lightgallery support, layout update, minor fixes and additions #494
Conversation
This file contains 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
ajstewart
changed the title
* Fixed docstring in config.py. * Updated all image captions. * Split off `DataTables` and `Tags and Favourites` to their own pages. * Expanded documentation of the documentation. * Enclosed all file examples in example admonition. * Renamed docs/quickstart -> docs/gettingstarted. * Added acknowledgements page. * Moved FAQs to before Reference. * Fixed MathJax and instant navigation.
|
@marxide as I went through every page hunting for images I also took the time to do some tidying and fixing, which I've summarised in the head comment. I think the contributing section is still a bit raw as I don't think either of us have really touched it, but I made sure to expand the documentation bit, seeing as there are now quite a few custom bolt ons. It probably needs further work beyond #492. |
[skip ci]
The code to add a "back to top" link to the table of contents would fail with an error message on pages that don't have a TOC. The link was also never added if the user started on a page without a TOC as the mkdocs-material instant loading feature prevents JS from being executed when navigating between local docs pages. This patch ensures the link is always added.
marxide
requested changes
Apr 29, 2021
Co-authored-by: Andrew O'Brien <[email protected]>
…ch-1 fix "back to top" TOC link
marxide
approved these changes
Apr 29, 2021
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.
A further documentation PR that includes:
DataTablesandTags and Favouritesto their own pages.docs/readme.mdas the repo readme is no longer used directly in the docs.Lightgallery example when opening images:
