gvergnaud / hotscript

A library of composable functions for the type-level! Transform your TypeScript types in any way you want using functions you already know.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Contributions Welcome] Documentation

gvergnaud opened this issue · comments

If we want this to be used, we will need to setup a good documentation website. What are the best tools to build technical docs these days?

commented

I use Docusaurus, easy to setup all markdown and we can automate delivering to gh-pages with github actions.
Almost everyone is using it in open source.
And then you can buy a domain for it (hotscript.org, hotscript.io, hotscript.dev are not taken)
I can buy one if you want

Yep. We use Docusaurus hosted on Netlify for all the Redux docs sites.

Also, we get a domain name via https://js.org .

commented

in my experience, gh-pages is actually easier to setup. everythings on github, easier to maintain.

You can set up a GH Pages with a github action pretty easily with docusaurus.