search

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.
3.38k stars 57 forks source link

[Contributions Welcome] Documentation #8

Open gvergnaud opened 1 year ago

gvergnaud commented 1 year ago

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?

ecyrbe commented 1 year ago

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

markerikson commented 1 year ago

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

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

ecyrbe commented 1 year ago

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

GavinMeierSonos commented 1 year ago

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