typedoc VS just-the-docs

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 think GitHub Pages only supports a whitelist of plugins, so you might have some more difficulties solving it well without any plugins. I use Netlify for my site, which does support arbitrary plugins.

One quick way to make it faster is to include that "_includes/nav.html" only in a nav.html, and then use an iframe to load that on every page, or something like that.

Anyway, I'm not the first to notice this it seems, although even "twice as fast" would still be quite slow: https://github.com/just-the-docs/just-the-docs/issues/1323

If it can help, there was a commenter earlier who suggested trying out a Doc-style github page that you can easily fork. It also has its own built-in search. Comment here. Github page here.

So the basic idea is I use the Jekyll site generator (which is already built into GitHub pages, but you can also install locally), and this is the theme I use: https://just-the-docs.github.io/just-the-docs/

That's certainly an option. Games like Liminal Horror and Into the Dungeon Revived host versions on GitHub. You can then render it to a GitHub.io page using something like Just the Docs.

The pages are written in markdown and the site has an in-built search feature. I am using the https://github.com/just-the-docs/just-the-docs jekyll theme.

The only people that like confluence have Stockholm syndrome. I'd argue that a wiki is the old people way of thinking. In most orgs a wiki is where data goes to die but some asshole keeps throwing data in there to appease some other asshole. I rather search slack, https://github.com/just-the-docs/just-the-docs, project boards in github, anything is better than confluence and I couldn't agree more that confluence search is the biggest piece of shit ever, it's worse than useless, it wastes your time.

https://pmarsceill.github.io/just-the-docs/

Especially if you're already familiar with Jekyll. Bonus points for being able to deploy on GitHub Pages!

You can use 'Just the Docs' (https://github.com/pmarsceill/just-the-docs) for documentation - it's a Jekyll-based theme for documentation and has built-in search.