Warning
This repo has stopped being used, typedoc markdown gets commited directly in to the clerk/clerk-docs repo.
See this pr where we changed over clerk/clerk-docs#2381
This repository contains the auto-generated Typedoc documentation of clerk/javascript.
Important
Do not manually edit .mdx files inside this repository. The contents will only be updated through CI automations and the source of truth for the documents is clerk/javascript. Any manual changes will be overriden.
If you want to make a change to a document, follow the instructions to setup your local environment and how to author Typedoc changes.
Once you opened a PR, it will be merged and released. Afterwards a GitHub action will update the contents of this repository.
You can reference files of this repository inside clerk-docs by using the <Typedoc src="relative-path/to/file" /> component (e.g. `).