docs: install typedoc for generating API docs #7060
Conversation
Josh-Cena
added
the
pr: documentation
|
cc @tgreyuk In case you are interested and have any suggestions. My ultimate goal is to emit Markdown that would very closely resemble our current documentation format, but the current output already looks far better than I expected! |
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site settings. |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-7060--docusaurus-2.netlify.app/ |
|
Size Change: +1.02 kB (0%) Total Size: 812 kB
ℹ️ View Unchanged
|
|
That looks interesting. The problem is that most theme-common is currently not a public API surface. If we document this officially on our website then users will start using internal APIs and we'll be in trouble. |
| @@ -120,7 +120,7 @@ export async function loadPluginConfigs( | |||
| // Site config should be the highest priority. | |||
| ...standalonePlugins, | |||
| ...standaloneThemes, | |||
| ]; | |||
| ].filter(<T>(x: T | false | null | undefined): x is T => Boolean(x)); | |||
There was a problem hiding this comment.
That's a change I think we could do and merge in another PR asap
I think we have an issue for it btw or it was discussed in the past
|
Ugh, looks too hard to maintain in the long run. Let's just hand-sync the docs instead. |
Motivation
Close #6649. Since we have JSDoc, we can use TypeDoc to autogenerate these APIs.
I would investigate how we can make it emit nicer Markdown—probably need to eventually fork the plugin and make lots of customizations.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
https://deploy-preview-7060--docusaurus-2.netlify.app/docs/api-next