From a987394782eaeb5f516e42034625c2a201251803 Mon Sep 17 00:00:00 2001 From: Henry de Valence Date: Wed, 5 Aug 2020 17:34:30 -0700 Subject: [PATCH] Add KaTeX to rendered docs. (#832) This adds a single test formula to the `zebra-chain` docs. We can remove it after merging this and running it through CI to confirm that it works. --- .github/workflows/firebase.yml | 4 ++++ katex-header.html | 8 ++++++++ zebra-chain/src/lib.rs | 2 ++ 3 files changed, 14 insertions(+) create mode 100644 katex-header.html diff --git a/.github/workflows/firebase.yml b/.github/workflows/firebase.yml index 36f597385..3dbca6f88 100644 --- a/.github/workflows/firebase.yml +++ b/.github/workflows/firebase.yml @@ -43,6 +43,8 @@ jobs: - name: Build external docs run: | cargo doc --no-deps + env: + RUSTDOCFLAGS: "--html-in-header katex-header.html" - name: Deploy external docs to firebase uses: w9jds/firebase-action@v1.5.0 @@ -55,6 +57,8 @@ jobs: - name: Build internal docs run: | cargo doc --no-deps --document-private-items + env: + RUSTDOCFLAGS: "--html-in-header katex-header.html" - name: Deploy external docs to firebase uses: w9jds/firebase-action@v1.5.0 diff --git a/katex-header.html b/katex-header.html new file mode 100644 index 000000000..78466e041 --- /dev/null +++ b/katex-header.html @@ -0,0 +1,8 @@ + + + + + diff --git a/zebra-chain/src/lib.rs b/zebra-chain/src/lib.rs index c823e6728..62bd310b0 100644 --- a/zebra-chain/src/lib.rs +++ b/zebra-chain/src/lib.rs @@ -1,4 +1,6 @@ //! Blockchain-related datastructures for Zebra. 🦓 +//! +//! $$a^2 + b^2 = c^2$$ #![doc(html_favicon_url = "https://www.zfnd.org/images/zebra-favicon-128.png")] #![doc(html_logo_url = "https://www.zfnd.org/images/zebra-icon.png")]