Skip to content

Commit 8f4046e

Browse files
authored
fix(docs): Mkdocs javascript fixes. (#421)
* fix(docs): Add javascript missing in the docs build * feat(docs): Check if UV is availsble to build docs * fix(docs): try mkdocs graphviz fork * fix(docs): try and fix javascript and abbreviation addons not being included in the docs * fix(docs): Fix name of graphviz javascript file * fix(docs): Addon Javascript now works properly. * fix(docs): Update Dependencies * fix(docs): Ignore mkdocs javascript files for spelling tests * fix(docs): Again try and fix javascript mkdocs spell errors
1 parent 7ea4bde commit 8f4046e

File tree

7 files changed

+416
-595
lines changed

7 files changed

+416
-595
lines changed

.config/dictionaries/project.dic

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ camelcase
77
canvaskit
88
cardano
99
Chromedriver
10+
chtml
1011
codegen
1112
colordiff
1213
cowsay
@@ -52,6 +53,7 @@ gosec
5253
graphviz
5354
idents
5455
ipynb
56+
javascripts
5557
JDBC
5658
jorm
5759
jormungandr
@@ -130,11 +132,11 @@ uniseg
130132
unshallow
131133
voteplan
132134
wasi
135+
wasip
133136
wasmtime
134137
webkitallowfullscreen
135138
WORKDIR
136139
xerrors
137140
xvfb
138141
zstd
139142
zstdcat
140-
wasip

cspell.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@
5555
"**/**/go.sum",
5656
"**/**/pyproject.toml",
5757
"examples/flutter/example/**",
58+
"earthly/docs/common/javascript/**"
5859
],
5960
"flagWords": [
6061
"don;t: don't"

earthly/docs/Earthfile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ deps:
5656
common:
5757
FROM scratch
5858

59-
COPY --dir common/includes common/macros common/overrides common/std-theme.yml /std
59+
COPY --dir common/includes common/javascript common/macros common/overrides common/std-theme.yml /std
6060

6161
SAVE ARTIFACT /std
6262

@@ -98,6 +98,8 @@ BUILD:
9898

9999
RUN /scripts/build.sh
100100

101+
RUN mv /docs/javascript/* /site/assets/javascripts
102+
101103
SAVE ARTIFACT /site/*
102104

103105

earthly/docs/common/javascript/tex-mml-chtml.js

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

earthly/docs/common/std-theme.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# cspell: words Diagramsnet, pymdownx, linenums, inlinehilite, superfences,
22
# cspell: words tasklist, betterem, materialx, twemoji, smartsymbols,
33
# cspell: words kroki, excalidraw, glightbox, cips, pygments, arithmatex, fontawesome
4-
# cspell: words massillia, mathjax
4+
# cspell: words massilia, mathjax
55

66
site_author: The Project Catalyst Team
77
copyright: (c) 2023 Input Output Global Ltd.
@@ -117,7 +117,6 @@ extra:
117117
make our documentation better.
118118
119119
extra_javascript:
120-
- javascript/massillia-graphviz.js
121-
- javascript/mathjax.js
122-
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
123-
120+
- assets/javascripts/massilia-graphviz.js
121+
- assets/javascripts/mathjax.js
122+
- assets/javascripts/tex-mml-chtml.js

earthly/docs/poetry.lock

Lines changed: 403 additions & 587 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

earthly/docs/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ readme = "Readme.md"
77

88
[tool.poetry.dependencies]
99
python = "^3.13"
10-
mkdocs-material = { version = "^9.6.12", extras = ["recommended","git","imaging"] }
10+
mkdocs-material = { version = "9.6.16", extras = ["recommended","git","imaging"] }
1111

1212
### MkDocs Plugins we add.
1313

0 commit comments

Comments
 (0)