Light

sanity-io / tsdoc Goto Github PK

Generate API reference docs from TypeScript projects and store in a Sanity-friendly JSON format. Render a static frontend, or as React components.

Home Page: https://tsdoc.sanity.build

License: MIT License

JavaScript 0.58% TypeScript 99.42%

api api-reference documentation generate sanity tsdoc typescript

tsdoc's Introduction

@sanity/tsdoc

Generate API reference docs from TypeScript projects and store in a Sanity-friendly JSON format. Render a static frontend, or as React components.

npm install @sanity/tsdoc

How to Release

The only thing you should need to do is to merge into the main branch. The release actions after merging should do the rest.

Make sure that you also don't only have chore commit messages

Note: If you squash and merge make sure that your PR title is named according to the semantic messages so that the sematic release can happen automatically. Otherwise you'll have to amment the commit message to an appropriate one

https://github.com/semantic-release/semantic-release

License

MIT © Sanity.io

tsdoc's People

Contributors

Stargazers

Watchers

Forkers

trustwarrior

tsdoc's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Using a curated preset maintained by

Sanity: The Composable Content Cloud

Warning

These dependencies are deprecated:

Datasource	Name	Replacement PR?
npm	`@types/mkdirp`
npm	`npm-run-all`
npm	`pkg-up`

Pending Approval

These branches will be created by Renovate only once you click their checkbox below.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

fix(deps): Update sanity monorepo (groq, pnpm)

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

chore(deps): replace dependency npm-run-all with npm-run-all2 ^5.0.0
fix(deps): update dependency mkdirp to v2 (mkdirp, @types/mkdirp)
fix(deps): update dependency react-refractor to v3

Detected dependencies

github-actions

.github/workflows/main.yml

actions/checkout v4

pnpm/action-setup v3

actions/setup-node v4

actions/create-github-app-token v1

actions/checkout v4

pnpm/action-setup v3

actions/setup-node v4

npm

package.json

@microsoft/api-extractor 7.47.0

@microsoft/api-extractor-model 7.29.2

@microsoft/tsdoc 0.15.0

@microsoft/tsdoc-config 0.17.0

@portabletext/react ^3.1.0

@portabletext/toolkit ^2.0.15

@sanity/client ^6.20.1

@sanity/color ^3.0.6

@sanity/icons ^3.3.0

@sanity/pkg-utils 6.10.2

@sanity/ui ^2.6.1

@types/cpx ^1.5.5

@vitejs/plugin-react ^4.3.1

cac ^6.7.14

chalk ^4.1.2

chokidar ^3.6.0

cors ^2.8.5

esbuild ^0.23.0

esbuild-register ^3.5.0

express ^4.19.2

groq ^3.49.0

groq-js ^1.10.0

history ^5.3.0

jsonc-parser ^3.3.1

mkdirp ^1.0.4

pkg-up ^3.1.0

react-refractor ^2.2.0

slugify ^1.6.6

tmp ^0.2.3

typescript 5.5.3

vite ^5.3.3

@sanity/semantic-release-preset ^5.0.0

@sanity/ui-workshop ^2.0.15

@types/cors ^2.8.17

@types/express ^4.17.21

@types/mkdirp ^1.0.2

@types/react ^18.3.3

@types/react-dom ^18.3.0

@types/tmp ^0.2.6

@types/uuid ^10.0.0

@types/yargs ^17.0.32

@typescript-eslint/eslint-plugin ^7.15.0

@typescript-eslint/parser ^7.15.0

cpx ^1.5.0

eslint ^8.57.0

eslint-config-prettier ^9.1.0

eslint-plugin-jsx-a11y ^6.9.0

eslint-plugin-prettier ^5.1.3

eslint-plugin-react ^7.34.3

eslint-plugin-react-hooks ^4.6.2

eslint-plugin-simple-import-sort 12.1.1

npm-run-all ^4.1.5

prettier ^3.3.2

prettier-plugin-packagejson ^2.5.0

react ^18.3.1

react-dom ^18.3.1

react-is ^18.3.1

refractor ^4.8.1

rimraf ^4.4.1

sanity ^3.49.0

semantic-release ^24.0.0

styled-components ^6.1.11

uuid ^10.0.0

vitest ^2.0.0

vitest-github-actions-reporter ^0.11.1

react ^18

react-dom ^18

sanity ^3

styled-components ^5.2 || ^6

node >=14.0.0

pnpm 9.4.0

react ^18.2.0

react-dom ^18.2.0

playground/multi-export-cjs-legacy/package.json

playground/multi-export-cjs/package.json

playground/multi-export-legacy/package.json

playground/multi-export/package.json

playground/mylib-bundling-ts/package.json

react ^18.0

playground/mylib/package.json

react ^18.0

playground/ts/package.json

Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.