https://github.com/clerk/generated-typedoc
Autogenerated Typedoc output of clerk/javascript
https://github.com/clerk/generated-typedoc
Last synced: 2 months ago
JSON representation
Autogenerated Typedoc output of clerk/javascript
- Host: GitHub
- URL: https://github.com/clerk/generated-typedoc
- Owner: clerk
- Archived: true
- Created: 2025-03-07T11:09:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-05T16:53:42.000Z (12 months ago)
- Last Synced: 2025-08-05T18:36:35.142Z (12 months ago)
- Language: MDX
- Homepage:
- Size: 205 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> [!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 https://github.com/clerk/clerk-docs/pull/2381
# generated-typedoc
This repository contains the auto-generated Typedoc documentation of [clerk/javascript](https://github.com/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](https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md#developing-locally) and how to author [Typedoc changes](https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md#authoring-typedoc-information).
Once you [opened a PR](https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md#opening-a-pull-request), 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](https://github.com/clerk/clerk-docs) by using the `` component (e.g. `).