Publish JS documentation to HexDocs#4216
Closed
rhcarvalho wants to merge 1 commit intophoenixframework:mainfrom
Closed
Publish JS documentation to HexDocs#4216rhcarvalho wants to merge 1 commit intophoenixframework:mainfrom
rhcarvalho wants to merge 1 commit intophoenixframework:mainfrom
Conversation
In order to make consuming and pointing to the LiveView JS documentation easier, this commit replicates the setup used in Phoenix to build and publish the JS documentation alongside the Elixir documentation in HexDocs. Because TypeScript is used in the LiveView JS codebase in the past year, use `typedoc` instead of `documentation` (which Phoenix uses for plain JS). By pointing `typedoc` directly to the `index.ts` entry point, we ensure only the public API is generated and documented. The resulting HexDocs sidebar includes a "JS Documentation" entry right after the Changelog, same as in Phoenix.
rhcarvalho
commented
May 6, 2026
| "cover": "npm run test && npm run cover:merge", | ||
| "cover:report": "npx monocart show-report cover/merged-js/index.html" | ||
| "cover:report": "npx monocart show-report cover/merged-js/index.html", | ||
| "docs": "typedoc assets/js/phoenix_live_view/index.ts --readme none --html doc/js" |
Contributor
Author
There was a problem hiding this comment.
--readme none matches the output in the Phoenix JS docs, i.e. it will not copy LiveView's README.md.
Without this the result was rather confusing, as the README is not written in the context of the JS codebase, but rather a general overview of the project.
| end | ||
|
|
||
| defp generate_js_docs(_) do | ||
| Mix.Task.run("app.start") |
Contributor
Author
There was a problem hiding this comment.
I'm not sure this is strictly necessary, mix docs seems to work just fine with this commented out. I copied from Phoenix' mix.exs.
Merged
Collaborator
|
Thank you! I needed to do some more changes to the LiveView code to not expose some of the things we only did because we didn't type the LiveSocket, e.g. |
Collaborator
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In order to make consuming and pointing to the LiveView JS documentation easier, this commit replicates the setup used in Phoenix to build and publish the JS documentation alongside the Elixir documentation in HexDocs.
Because TypeScript is used in the LiveView JS codebase in the past year, use
typedocinstead ofdocumentation(which Phoenix uses for plain JS). By pointingtypedocdirectly to theindex.tsentry point, we ensure only the public API is generated and documented.The resulting HexDocs sidebar includes a "JS Documentation" entry right after the Changelog, same as in Phoenix.
Preview
HexDocs index/sidebar
JS/TS docs