Repository navigation
docs: generate the API reference with TypeDoc - #11
Merged
Merged
Conversation
Add TypeDoc with typedoc-plugin-markdown and a small local plugin that shapes the output for docs/navigation/api in rnmapbox/maps-docs (frontmatter, sidebar categories, MDX-safe). `yarn docs` writes it to docs/api; CI runs it with warnings as errors. update-docs.yml regenerates it from each published release and pushes it to maps-docs. Fill in the JSDoc the reference is built from, and update the README now that the package is on npm under `next`.
Docusaurus treats Navigation/Navigation.md as the category's index page.
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
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.
Generates the API reference from the JSDoc in
src/with TypeDoc andtypedoc-plugin-markdown.scripts/typedoc-docusaurus.mjsshapes the output fordocs/navigation/api/in rnmapbox/maps-docs: frontmatter with an edit link to the source, a "generated, don't edit" comment, and sidebar categories per@group(Core, Components, Routes, Events).yarn docswrites todocs/api/(gitignored), and CI runs it with warnings as errors so broken{@link}s fail..github/workflows/update-docs.ymlruns onrelease: published(or manually with a ref), generates from the tag and pushes to maps-docs. It needs aMAPS_DOCS_DEPLOY_KEYsecret with write access to rnmapbox/maps-docs.Also fills in thin JSDoc, and fixes the README: the package is on npm as
@rnmapbox/navigation@next, and why@rnmapbox/maps>= 10.3.11 is required.The generated site for alpha.1 is in rnmapbox/maps-docs#14.