doks VS typedoc

He just recommended that I use HUGO to set up a simple, static website for a non-profit that could be hosted for free on Github and would be fairly simple for me to update using markdown. It sounded like a wonderful idea. He downloaded HUGO & set up WSL for my Windows Terminal for me & I was pretty much on my own to find tutorials for Git & Github, VSCode, Hugo & the Hugo Doks Theme.

Recently I started to configure my digital garden. Foam is a good option, Hugo Doks, No Style Please, Git-Wiki, Researcher, Thinkspace, and other themes are good for zetteltasken pages.

Take a look at this theme for documentation. https://getdoks.org/

Thanks, yes of course — https://getdoks.org/.

Download Doks theme for Hugo

Download Doks Doks demo site Minimum Hugo version: 0.80 GitHub stars: 952 License: MIT

I am trying to create a second docs page, e.g. called `docs`, that should have the same layout as the `docs` page. I managed to do this by following [this](https://github.com/h-enk/doks/discussions/173) discussion topic. I managed to add the second page, all with correct menu entries and the sidebar showing correctly.

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).