web
extractor
| web | extractor | |
|---|---|---|
| 4 | 2 | |
| 106 | 11 | |
| 0.9% | - | |
| 7.9 | 9.7 | |
| 7 days ago | 7 days ago | |
| TypeScript | TypeScript | |
| GNU Affero General Public License v3.0 | GNU Affero General Public License v3.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
web
- Typejuice: Docs generator for .d.ts files inspired by godoc
-
I made a website that documents TypeScript packages
The raw JSDoc comments (for example, /** sum adds two numbers */) are parsed with tsdoc and rendered with custom React components.
-
Show HN: Automatic Documentation for TypeScript Packages
Thank you for your question, I don't have experience with Docusaurus but I'll try to list a few ideas, let me know if it can help you.
If you only need raw package metatada (signatures, docs...) that Docusaurus will render somehow at build time you may use my extractor which outputs a plain Javascript object with the collected information (see https://github.com/jsdocs-io/extractor/blob/main/test/packag...).
If you need pre-rendered docs that Docusaurus will embed in a page you may implement something like a React component (see https://github.com/jsdocs-io/web/blob/main/src/components/pa...) and use the raw metadata as component props.
If you need a pre-rendered page that Docusaurus will collect, you may want to look into https://www.npmjs.com/package/@microsoft/api-extractor which can directly output Markdown files (as well as JSON files) but requires some initial setup to get working.
extractor
-
I made a website that documents TypeScript packages
The declarations (functions, variables, classes ...) and their docs are extracted with a custom API extractor I built based on the ts-morph library and the TypeScript compiler.
-
Show HN: Automatic Documentation for TypeScript Packages
Thank you for your question, I don't have experience with Docusaurus but I'll try to list a few ideas, let me know if it can help you.
If you only need raw package metatada (signatures, docs...) that Docusaurus will render somehow at build time you may use my extractor which outputs a plain Javascript object with the collected information (see https://github.com/jsdocs-io/extractor/blob/main/test/packag...).
If you need pre-rendered docs that Docusaurus will embed in a page you may implement something like a React component (see https://github.com/jsdocs-io/web/blob/main/src/components/pa...) and use the raw metadata as component props.
If you need a pre-rendered page that Docusaurus will collect, you may want to look into https://www.npmjs.com/package/@microsoft/api-extractor which can directly output Markdown files (as well as JSON files) but requires some initial setup to get working.
What are some alternatives?
tsdoc - A doc comment standard for TypeScript
ts-morph - TypeScript Compiler API wrapper for static analysis and programmatic code changes.
smartblock - intuitive block based wysiwyg editor built with React and ProseMirror
tsParticles - tsParticles - Easily create highly customizable JavaScript particles effects, confetti explosions and fireworks animations and use them as animated backgrounds for your website. Ready to use components available for React.js, Vue.js (2.x and 3.x), Angular, Svelte, jQuery, Preact, Inferno, Solid, Riot and Web Components.
typedoc - Documentation generator for TypeScript projects.
open-source - Open Source Angular Libraries contributed by @myndpm
typejuice - Documentation generator for TypeScript Declaration Files inspired by godoc.
mailgo - 💌 mailgo, a new concept of mailto and tel links [deprecated]
rushstack - Monorepo for tools developed by the Rush Stack community