typedoc VS cuetorials.com

Firstly, install Typedoc using npm:

Background:The main bottleneck with the TypeDoc default theme especially for large projects is the verbose HTML for the left-hand navigation that linearly grows for each page based on the project size and consumes a massive amount of disk space; see this TypeDoc issue. The DMT caches the left-hand navigation HTML and dynamically creates a shared web component that is utilized across all pages only making a single copy of the navigation HTML. This reduces disk space utilization by up to 90% and also makes doc generation ~80% faster. I also include some style additions and replace the main search index generation using compressed MesssagePack instead of JSON which reduces the search index size by more than 90%.

While the Prim+RPC server is expected to be JavaScript, I'd like to support other languages through JSON Schema. I wrote a tool that translates TypeDoc comments into RPC-specific documentation. My plan is to turn this result into JSON Schema that can be served with the Prim+RPC server. This means you can get typed suggestions (for instance, from an IDE that understands JSON Schema) when writing requests in JSON files (I wrote a little about this here, still a WIP). From this, you could use your favorite HTTP client in the language of your choice, like but still benefit from having typed requests.

Docusaurus has a Typedoc plugin. Also there is a typedoc markdown plugin.

Finally, JSDoc can be used to generate documentation for your code using tools like JSDoc itself and TypeDoc. These tools generate HTML or Markdown documentation based on your JSDoc annotations, making it easier for others to understand how your code works and how to use it.

Since you're using TypeScript, use TypeDoc.

Generates HTML documentation using TypeDoc.

I was thinking of using something like https://typedoc.org to do it, do you have experience with this sort of tools?

TSDoc is more consistent, has cleaner documentation, better tooling (e.g. TypeDoc or ESLint plugin) and better support for data structures (e.g. straightforward enums support).

I have a website I maintain, many people tell me it has helped them

https://cuetorials.com

CUE(lang), because devops & yaml engineering has gotten out of hand

I maintain https://cuetorials.com and am heading up the CUE sig-infra group for the time being

If you need help with CUE(lang), we maintain https://cuetorials.com and have experience helping others adopt it at their companies

email is in my HN profile, same handle on GitHub and X

If you are more focused on the devops part, and not implementing a static site generator, then go with Python. For our static sites we use Hugo + GH Actions + Kubernetes (since we have a cluster anyway). There is not really any code involved here (example: https://github.com/hofstadter-io/cuetorials.com)

I'm personally interested to try https://docs.dagger.io/sdk/python/ for something. I used the CUE sdk, but it is effectively deprecated at this point. I use a mix of base, make, python, and CUE fro most devops / devex stuff now. Dagger makes it so local & CI stuff runs the same.

yup, I'm betting the proverbial ranch on CUE :]

I also maintain https://cuetorials.com

I also maintain https://cuetorials.com, bet the farm on CUE or something like that :]