From cc9cd0ee96adad2d00776867df8e3ab55ee2fd1c Mon Sep 17 00:00:00 2001 From: Alberto Mengali Date: Thu, 31 Aug 2023 10:56:47 +0200 Subject: [PATCH] update README and html example --- README.md | 8 +++----- html_exports/test_bondstable.jl.html | 10 +++++----- test/notebooks/structbondmodule.jl | 20 ++++++++++---------- 3 files changed, 18 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index df512a3..7fe4b08 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ # PlutoExtras +[![Build Status](https://github.com/disberd/PlutoExtras.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/disberd/PlutoExtras.jl/actions/workflows/CI.yml?query=branch%3Amaster) +[![Coverage](https://codecov.io/gh/disberd/PlutoExtras.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/disberd/PlutoExtras.jl) This package provides some widgets to be used in Pluto, including an extended version of the TableOfContents from PlutoUI and a new experimental bond container (`BondTable`). @@ -11,7 +13,7 @@ There is some new under-development experimental feature to simplify the groupin Have a look at the notebook at [notebooks/test_bondstable.jl](https://rawcdn.githack.com/disberd/PlutoExtras.jl/94fdc84217b5591343ba4671666511d16b1c0eaf/html_exports/test_bondstable.jl.html) for an example of the features/capabilities. (The link points to a static html export of the notebook. If you want to execute the notebook, remember that it has to be executed from the cloned repository as it currently uses the package environment of the package) ## ExtendedTableOfContents -The [extended_toc.jl](./src/extended_toc.jl) notebook defines and exports `ExtendedTableOfContents`, which takes the `TableOfContents` from `PlutoUI` and adds the following functionalities: +The [extended_toc.jl](./test/notebooks/extended_toc.jl) notebook shows the example use of `ExtendedTableOfContents`, which takes the `TableOfContents` from `PlutoUI` and adds the following functionalities: ### Hiding Heading/Cells Hiding headings and all connected cells from notebook view can be done via ExtendedTableOfContents @@ -23,10 +25,6 @@ Hiding headings and all connected cells from notebook view can be done via Exten ### Collapsing Headings in ToC ToC headings are grouped based on heading level, sub-headings at various levels can be collapsed by using the caret symbol that appears to the left of headings in the ToC upon hover. -### Scroll behavior fix -The weird scrolling issue appearing on chromium-based browsers with the scrolling in the TableOfContents (see https://github.com/JuliaPluto/PlutoUI.jl/issues/238) is fixed by relying on the [SmoothScroll](https://github.com/LieutenantPeacock/SmoothScroll/) library. -- _SmoothScroll_ is used by default to replace the scroll upon heading click behavior. To maintain the original behavior, call `ExtendedTableOfContents(;use_smoothscroll = false)` - ### Save Hide/Collapsed status on notebook file Preserving the status of collapsed/hidden heading is supported by writing to the notebook file using notebook and cell metadata, allowing to maintain the status even upon reload of Julia/Pluto - When the current collapsed/hidden status of each heading is not reflected in the notebook file, a save icon/button appears on the left of the ToC title upon hover. Clicking the icon saves the current state in the notebook file. diff --git a/html_exports/test_bondstable.jl.html b/html_exports/test_bondstable.jl.html index c3ba890..13dbbd7 100755 --- a/html_exports/test_bondstable.jl.html +++ b/html_exports/test_bondstable.jl.html @@ -1,15 +1,15 @@ - -
\ No newline at end of file +
\ No newline at end of file diff --git a/test/notebooks/structbondmodule.jl b/test/notebooks/structbondmodule.jl index d629e57..4bcda6f 100644 --- a/test/notebooks/structbondmodule.jl +++ b/test/notebooks/structbondmodule.jl @@ -365,31 +365,31 @@ version = "17.4.0+2" """ # ╔═╡ Cell order: -# ╠═9d4455af-96f1-46d7-a4f3-434495b11c8a +# ╟─9d4455af-96f1-46d7-a4f3-434495b11c8a # ╠═8db82e94-5c81-4c52-9228-7e22395fb68f # ╠═949ac1ef-c502-4e28-81ff-f99b0d19aa03 # ╠═707175a9-d356-43cf-8038-620ebc401c93 -# ╠═4843983c-df64-4b94-8634-7a10d9423a70 +# ╟─4843983c-df64-4b94-8634-7a10d9423a70 # ╟─a8995224-83c6-4f82-b5a5-87a6f86fc7a0 # ╠═9e3601f5-efc2-44e9-83d8-5b65ce7e9ccf # ╠═cdc0a7ad-a3ac-4270-b707-35b1939da276 # ╠═49516374-f625-4a84-ac5c-f92497d45025 -# ╠═8cc53cd2-9114-4067-ab0b-37fd8cd79240 +# ╟─8cc53cd2-9114-4067-ab0b-37fd8cd79240 # ╠═0db51d39-7c05-4e00-b951-7fe776a8e0f9 # ╠═e2b79a58-e66e-4d40-8673-418823753b38 -# ╠═9d23382c-cf35-4b20-a46c-0f4e2de17fc7 -# ╠═959acb40-1fd6-43f5-a1a6-73a6ceaae1d7 +# ╟─9d23382c-cf35-4b20-a46c-0f4e2de17fc7 +# ╟─959acb40-1fd6-43f5-a1a6-73a6ceaae1d7 # ╠═4d611425-c8e3-4bc3-912b-8bc0465363bc # ╠═a5490a6b-dc11-42b7-87e0-d38870fc55e4 # ╠═705e30fe-77a3-4b06-8b99-1807290edffb -# ╠═2ee7f26d-f383-4e7e-a69a-8fb72717467c -# ╠═79beba88-932f-4147-b3a0-d821ef1bc1e2 +# ╟─2ee7f26d-f383-4e7e-a69a-8fb72717467c +# ╟─79beba88-932f-4147-b3a0-d821ef1bc1e2 # ╠═63d6c2df-a411-407c-af11-4f5d09fbb322 # ╠═633029af-8cac-426e-b35c-c9fb3938b784 -# ╠═2073f11e-8196-4ebc-922f-5fa589e91797 +# ╟─2073f11e-8196-4ebc-922f-5fa589e91797 # ╠═811cf78b-e870-45bb-9173-89a3b3d495f5 -# ╠═3a066bf4-3466-469e-90d0-6b14be3ed8d5 -# ╠═3213d977-7b65-43b0-a881-10fcc2523f14 +# ╟─3a066bf4-3466-469e-90d0-6b14be3ed8d5 +# ╟─3213d977-7b65-43b0-a881-10fcc2523f14 # ╠═903fee67-6b23-41dc-a03d-f1040b696be6 # ╟─00000000-0000-0000-0000-000000000001 # ╟─00000000-0000-0000-0000-000000000002