Update typedoc-plugin-markdown to 4.0.0 #4870
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Ignored Deployment
|
| @@ -26,9 +26,7 @@ Google Tag Manager, IAB TCF, etc. | |||
| See [Fides](interfaces/Fides.md) for how to use the `window.Fides` JavaScript API, [FidesOptions](interfaces/FidesOptions.md) for supported options to customize it's behavior, and [FidesEvent](interfaces/FidesEvent.md) for how to use `window.addEventListener(...)` to subscribe to | |||
| custom Fides events for real-time updates. | |||
|
|
|||
| ## Table of contents | |||
There was a problem hiding this comment.
Table of contents are removed: https://typedoc-plugin-markdown.org/docs/migration-guide#-breaking-changes
I'm OK with that.
| @@ -32,24 +32,11 @@ existence of Fides *or* subscribe to the global `FidesInitialized` event (see | |||
| </body> | |||
| ``` | |||
|
|
|||
| ## Table of contents | |||
There was a problem hiding this comment.
This TOC was helpful, but I think it's OK. When we package these up and host on our docs site, the sidebar generates a new TOC from the headings anyways: https://ethyca.com/docs/dev-docs/js/reference/interfaces/Fides
There was a problem hiding this comment.
The inline TOC was annoying me for that reason. I think it's a good move. I like the sidebar much better.
|
|
||
| ### getModalLinkLabel | ||
| ### getModalLinkLabel() |
There was a problem hiding this comment.
🤌 excellent little hint showing () for a function, thank you maintainers
| @@ -226,19 +209,15 @@ function myCustomShowModalFunction() { | |||
| } | |||
| ``` | |||
|
|
|||
| #### Type declaration | |||
There was a problem hiding this comment.
Wasn't helpful, now it's gone. Bonus!
| @@ -70,8 +70,9 @@ | |||
| "rollup-plugin-postcss": "^4.0.2", | |||
| "rollup-plugin-visualizer": "^5.12.0", | |||
| "ts-jest": "^29.1.0", | |||
| "typedoc": "^0.25.13", | |||
There was a problem hiding this comment.
I should have included this previously! It was getting pulled in as a peer dependency.
Passing run #7626 ↗︎
Details:
Review all test suite changes for PR #4870 ↗︎ |
|||||||||||||||
| @@ -32,24 +32,11 @@ existence of Fides *or* subscribe to the global `FidesInitialized` event (see | |||
| </body> | |||
| ``` | |||
|
|
|||
| ## Table of contents | |||
There was a problem hiding this comment.
The inline TOC was annoying me for that reason. I think it's a good move. I like the sidebar much better.
| @@ -65,7 +52,7 @@ The specific keys provided in the `Fides.consent` property are determined | |||
| based on your Fides configuration, and are provided to the browser based on | |||
| the user's location, property ID, etc. | |||
|
|
|||
| **`Example`** | |||
| #### Example | |||
Description Of Changes
This updates
typedoc-plugin-markdownto the latest release and follows the v4 migration guide to tweak a couple of the formatting features 👍This improves the format of the generated
.mdfiles in a couple ways which I like, including removing the inline table of contents that was OK but more confusing than helpful in our docs.NOTE: I originally did this hoping to find a way to add some additional pages to document features that aren't strictly part of the types (e.g. guides) but looks like we'll need to wait until this plugin supports the
typedocbeta: TypeStrong/typedoc#2567Code Changes
typedoc-plugin-markdowndependencypackage.json'stypedocOptionsconfiguration to be 🤌 just right 🤌Steps to Confirm
turbo buildin theclients/fides-jsproject and check thedocs/outputPre-Merge Checklist
CHANGELOG.md