Update template (#9)

Author: mtfishman

.github/workflows/VersionCheck.yml

@@ -0,0 +1,11 @@
+name: "Version Check"
+
+on:
+  pull_request:
+
+jobs:
+  version-check:
+    name: "Version Check"
+    uses: "ITensor/ITensorActions/.github/workflows/VersionCheck.yml@main"
+    with:
+      localregistry: https://github.com/ITensor/ITensorRegistry.git

Project.toml

@@ -1,7 +1,7 @@
 name = "TensorProducts"
 uuid = "decf83d6-1968-43f4-96dc-fdb3fe15fc6d"
 authors = ["ITensor developers <[email protected]> and contributors"]
-version = "0.1.2"
+version = "0.1.3"
 
 [weakdeps]
 BlockArrays = "8e7c35d0-a365-5155-bbbb-fb81a777f24e"

README.md

@@ -1,15 +1,19 @@
 # TensorProducts.jl
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/TensorProducts.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/TensorProducts.jl/dev/)
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://itensor.github.io/TensorProducts.jl/stable/)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://itensor.github.io/TensorProducts.jl/dev/)
 [![Build Status](https://github.com/ITensor/TensorProducts.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/TensorProducts.jl/actions/workflows/Tests.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/ITensor/TensorProducts.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/TensorProducts.jl)
 [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
 [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 
 ## Support
 
-<img src="docs/src/assets/CCQ.png" width="20%" alt="Flatiron Center for Computational Quantum Physics logo.">
+<picture>
+  <source media="(prefers-color-scheme: dark)" width="20%" srcset="docs/src/assets/CCQ-dark.png">
+  <img alt="Flatiron Center for Computational Quantum Physics logo." width="20%" src="docs/src/assets/CCQ.png">
+</picture>
+
 
 TensorProducts.jl is supported by the Flatiron Institute, a division of the Simons Foundation.
 

docs/make.jl

@@ -10,9 +10,9 @@ makedocs(;
   authors="ITensor developers <[email protected]> and contributors",
   sitename="TensorProducts.jl",
   format=Documenter.HTML(;
-    canonical="https://ITensor.github.io/TensorProducts.jl",
+    canonical="https://itensor.github.io/TensorProducts.jl",
     edit_link="main",
-    assets=["assets/favicon.ico"],
+    assets=["assets/favicon.ico", "assets/extras.css"],
   ),
   pages=["Home" => "index.md", "Reference" => "reference.md"],
 )

docs/make_index.jl

@@ -4,7 +4,8 @@ using TensorProducts: TensorProducts
 function ccq_logo(content)
   include_ccq_logo = """
     ```@raw html
-    <img src="assets/CCQ.png" width="20%" alt="Flatiron Center for Computational Quantum Physics logo.">
+    <img class="display-light-only" src="assets/CCQ.png" width="20%" alt="Flatiron Center for Computational Quantum Physics logo."/>
+    <img class="display-dark-only" src="assets/CCQ-dark.png" width="20%" alt="Flatiron Center for Computational Quantum Physics logo."/>
     ```
     """
   content = replace(content, "{CCQ_LOGO}" => include_ccq_logo)

docs/make_readme.jl

@@ -3,7 +3,10 @@ using TensorProducts: TensorProducts
 
 function ccq_logo(content)
   include_ccq_logo = """
-    <img src="docs/src/assets/CCQ.png" width="20%" alt="Flatiron Center for Computational Quantum Physics logo.">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" width="20%" srcset="docs/src/assets/CCQ-dark.png">
+      <img alt="Flatiron Center for Computational Quantum Physics logo." width="20%" src="docs/src/assets/CCQ.png">
+    </picture>
     """
   content = replace(content, "{CCQ_LOGO}" => include_ccq_logo)
   return content
@@ -14,5 +17,5 @@ Literate.markdown(
   joinpath(pkgdir(TensorProducts));
   flavor=Literate.CommonMarkFlavor(),
   name="README",
-  preprocess=ccq_logo,
+  postprocess=ccq_logo,
 )

docs/src/assets/CCQ-dark.png

@@ -0,0 +1,15 @@
+.display-light-only {
+    display: block;
+}
+
+.display-dark-only {
+    display: none;
+}
+
+.theme--documenter-dark .display-light-only {
+    display: none;
+}
+
+.theme--documenter-dark .display-dark-only {
+    display: block;
+}