Skip to content

Commit

Permalink
docs: sanitize comments for typescript doctype (#8660)
Browse files Browse the repository at this point in the history
* docs: sanitize comments for typescript doctype

Recently we added "${VAR}" snippets into our docs - however, as doctype
was generating MDX output, this was weirdly being interpreted as
variable interpolations.

There is a setting to control this: `sanitizeComments`. However, this
is only present in newer versions of the doctype plugin, so, a whole
upgrade of doctype and its docusaurus plugins is required, so I've done
that here too.

Signed-off-by: Justin Chadwell <me@jedevc.com>

* ci: use cache for docusaurus operations

Signed-off-by: Justin Chadwell <me@jedevc.com>

* chore: update expand docstrings to have quotes

Signed-off-by: Justin Chadwell <me@jedevc.com>

* ci: add docs lint check that the site builds

Signed-off-by: Justin Chadwell <me@jedevc.com>

---------

Signed-off-by: Justin Chadwell <me@jedevc.com>
  • Loading branch information
jedevc authored Oct 9, 2024
1 parent 1d9f2e6 commit 2f664bf
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions dagger.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 2f664bf

Please sign in to comment.