Merge pull request #122 from input-output-hk/plt-8836

Inject css and html element via JSX and plugin

.github/workflows/deploy-docs.yaml

@@ -42,7 +42,7 @@ jobs:
 
       - name: 🔨 Build Docs
         run: |
-          nix develop --show-trace --command bash -c "npm i && npm run build && npm run docs"
+          nix develop --show-trace --command bash -c "npm i && npm run build && npm --prefix ./doc/theme/ run build && npm run docs"
 
       - name: 📘 Upload artifact
         uses: actions/upload-pages-artifact@v2

.github/workflows/test-suite.yaml

@@ -35,7 +35,7 @@ jobs:
 
       - name: 🏥 Check docs generation
         run: |
-          nix develop --show-trace --command bash -c "npm run docs"
+          nix develop --show-trace --command bash -c "npm --prefix ./doc/theme/ run build && npm run docs"
       - name: 📝 Check formatting
         run: |
           nix develop --show-trace --command bash -c "treefmt --fail-on-change"

changelog.d/20240105_164037_hrajchert_plt_8836.md

@@ -0,0 +1,3 @@
+### General
+
+- Changed documentation theme

doc/theme/.editorconfig

@@ -0,0 +1,11 @@
+# https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

doc/theme/.gitignore

@@ -0,0 +1,22 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Compiled output
+dist
+
+# Dependency directories
+node_modules/
+
+# Output of 'npm pack'
+*.tgz
+
+# Output of running `yarn typedoc src` on this repo
+docs

doc/theme/README.md

@@ -0,0 +1,17 @@
+## Marlowe Typedoc Theme
+
+Theme for typedoc is done through a plugin that expands upon the default theme and allows JSX hooks/overrides to modify DOM.
+
+Configurations for running this can be found in the root `package.json` file where `npm run docs` will run typedoc with configurations found in `typedoc.json`.
+
+Typedoc's [example demo theme](https://github.com/Gerrit0/typedoc-custom-theme-demo) shows how various hooks are called within `index.tsx`. This entrypoint also contains a sync script for processing files in `/assets`.
+
+Elements that are replaced from the default theme can be found under `/templates`. Additional templates can be added for more granular control (See toolbar as an example).
+
+To build the theme:
+
+```
+npm run build
+```
+
+This creates a `/dist` directory which is configured by `typedoc.json` as the plugin. Continue to build the docs `npm run docs` from the directory root, then preview any changes locally with `npm run serve`.