From 0626cd93c4f12f4f3d7469d8eda92ee860b607aa Mon Sep 17 00:00:00 2001 From: Michael Tiemann <126827163+mitiemann@users.noreply.github.com> Date: Mon, 23 Dec 2024 22:27:50 +0100 Subject: [PATCH] Add docs|badge img to main page (#128) * update Julia LTS version to 1.10.6 * add badge image to home page * add inline badge img --- Manifest.toml | 44 ++++++++++++++++++++------------------------ _css/custom.css | 10 ++++++++++ index.md | 2 +- 3 files changed, 31 insertions(+), 25 deletions(-) diff --git a/Manifest.toml b/Manifest.toml index 7fd3893..7d26aaa 100644 --- a/Manifest.toml +++ b/Manifest.toml @@ -1,6 +1,6 @@ # This file is machine-generated - editing it directly is not advised -julia_version = "1.10.4" +julia_version = "1.10.6" manifest_format = "2.0" project_hash = "fd73ef33d480b0816d7728a667dba4ef62c44c52" @@ -29,9 +29,9 @@ uuid = "8bf52ea8-c179-5cab-976a-9e18b702a9bc" [[deps.CodecZlib]] deps = ["TranscodingStreams", "Zlib_jll"] -git-tree-sha1 = "b8fe8546d52ca154ac556809e10c75e6e7430ac8" +git-tree-sha1 = "bce6804e5e6044c6daab27bb533d1295e4a2e759" uuid = "944b1d66-785c-5afd-91f1-9de20f533193" -version = "0.7.5" +version = "0.7.6" [[deps.ConcurrentUtilities]] deps = ["Serialization", "Sockets"] @@ -50,9 +50,9 @@ version = "1.6.0" [[deps.ExceptionUnwrapping]] deps = ["Test"] -git-tree-sha1 = "dcb08a0d93ec0b1cdc4af184b26b591e9695423a" +git-tree-sha1 = "d36f682e590a83d63d1c7dbd287573764682d12a" uuid = "460bff9d-24e4-43bc-9d9f-a8973cb893f4" -version = "0.1.10" +version = "0.1.11" [[deps.FileWatching]] uuid = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee" @@ -65,9 +65,9 @@ version = "0.7.1" [[deps.HTTP]] deps = ["Base64", "CodecZlib", "ConcurrentUtilities", "Dates", "ExceptionUnwrapping", "Logging", "LoggingExtras", "MbedTLS", "NetworkOptions", "OpenSSL", "Random", "SimpleBufferStream", "Sockets", "URIs", "UUIDs"] -git-tree-sha1 = "d1d712be3164d61d1fb98e7ce9bcbc6cc06b45ed" +git-tree-sha1 = "1336e07ba2eb75614c99496501a8f4b233e9fafe" uuid = "cd3eb016-35fb-5094-929b-558a96fad6f3" -version = "1.10.8" +version = "1.10.10" [[deps.IOCapture]] deps = ["Logging", "Random"] @@ -81,9 +81,9 @@ uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240" [[deps.JLLWrappers]] deps = ["Artifacts", "Preferences"] -git-tree-sha1 = "7e5d6779a1e09a36db2a7b6cff50942a0a7d0fca" +git-tree-sha1 = "be3dc50a92e5a386872a493a10050136d4703f9b" uuid = "692b3bcd-3c85-4b1f-b108-f13ce0eb3210" -version = "1.5.0" +version = "1.6.1" [[deps.LibCURL]] deps = ["LibCURL_jll", "MozillaCACerts_jll"] @@ -113,19 +113,19 @@ version = "1.11.0+1" uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb" [[deps.LiveServer]] -deps = ["HTTP", "LoggingExtras", "MIMEs", "Pkg", "Sockets", "Test"] -git-tree-sha1 = "1e46b873b8ef176e23ee43f96e72cd45c20bafb4" +deps = ["HTTP", "LoggingExtras", "MIMEs", "Sockets", "Test"] +git-tree-sha1 = "564a436267fb1fc768f815dad64c4386c46623f8" uuid = "16fef848-5104-11e9-1b77-fb7a48bbb589" -version = "1.3.1" +version = "1.4.0" [[deps.Logging]] uuid = "56ddb016-857b-54e1-b83d-db4d58db5568" [[deps.LoggingExtras]] deps = ["Dates", "Logging"] -git-tree-sha1 = "c1dd6d7978c12545b4179fb6153b9250c96b0075" +git-tree-sha1 = "f02b56007b064fbfddb4c9cd60161b6dd0f40df3" uuid = "e6f89c97-d47a-5376-807f-9c37f3926c36" -version = "1.0.3" +version = "1.1.0" [[deps.MIMEs]] git-tree-sha1 = "65f28ad4b594aebe22157d6fac869786a255b7eb" @@ -169,9 +169,9 @@ version = "1.4.3" [[deps.OpenSSL_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl"] -git-tree-sha1 = "a028ee3cb5641cccc4c24e90c36b0a4f7707bdf5" +git-tree-sha1 = "7493f61f55a6cce7325f197443aa80d32554ba10" uuid = "458c3c95-2e84-50aa-8efc-19380b2a3a95" -version = "3.0.14+0" +version = "3.0.15+1" [[deps.OrderedCollections]] git-tree-sha1 = "dfdf5519f235516220579f949664f1bf44e741c5" @@ -220,9 +220,9 @@ version = "0.7.0" uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b" [[deps.SimpleBufferStream]] -git-tree-sha1 = "874e8867b33a00e784c8a7e4b60afe9e037b74e1" +git-tree-sha1 = "f305871d2f381d21527c770d4788c06c097c9bc1" uuid = "777ac1f9-54b0-4bf8-805c-2214025038e7" -version = "1.1.0" +version = "1.2.0" [[deps.Sockets]] uuid = "6462fe0b-24de-5631-8697-dd941f90decc" @@ -242,13 +242,9 @@ deps = ["InteractiveUtils", "Logging", "Random", "Serialization"] uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40" [[deps.TranscodingStreams]] -git-tree-sha1 = "60df3f8126263c0d6b357b9a1017bb94f53e3582" +git-tree-sha1 = "0c45878dcfdcfa8480052b6ab162cdd138781742" uuid = "3bb67fe8-82b1-5028-8e26-92a6c54297fa" -version = "0.11.0" -weakdeps = ["Random", "Test"] - - [deps.TranscodingStreams.extensions] - TestExt = ["Test", "Random"] +version = "0.11.3" [[deps.URIs]] git-tree-sha1 = "67db6cc7b3821e19ebe75791a9dd19c9b1188f2b" diff --git a/_css/custom.css b/_css/custom.css index beedbb1..951a210 100644 --- a/_css/custom.css +++ b/_css/custom.css @@ -27,6 +27,15 @@ object-fit: scale-down; } +/* Custom CSS required to display the docs|stable badge on the landing page */ +img[alt=badge] { + height: 1em; + width: auto; + display: inline; + margin: 0; + padding: 0 0.5ex; +} + /* ================================================================== Admonitions ================================================================== */ @@ -114,3 +123,4 @@ recognized as Ruby code. Since we don't have any Ruby code in MJW, this is a qui TODO: remove when not required in Xranklin. */ .language-ruby::before {content: "Julia";} + diff --git a/index.md b/index.md index 771bfa7..ffd51e5 100644 --- a/index.md +++ b/index.md @@ -33,4 +33,4 @@ But at least you will know where to look in case you have a specific question. Many of the links you will see point to [GitHub](https://github.com/) repositories for Julia packages. When you click them, they will take you to a page called `README.md` that contains a brief description of the package, sometimes insufficient for actual use. -You can usually find more thorough documentation by looking for a blue badge called [`docs|stable`](https://img.shields.io/badge/docs-stable-blue.svg) at the top of the page. +You can usually find more thorough documentation by clicking on a blue badge called `docs|stable` looking like this ![badge](https://img.shields.io/badge/docs-stable-blue.svg) at the top of the `README`.