Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Contributions Welcome] Documentation #8

Open
gvergnaud opened this issue Feb 13, 2023 · 4 comments
Open

[Contributions Welcome] Documentation #8

gvergnaud opened this issue Feb 13, 2023 · 4 comments

Comments

@gvergnaud
Copy link
Owner

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
Copy link
Collaborator

ecyrbe commented Feb 13, 2023

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
Copy link

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

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

@ecyrbe
Copy link
Collaborator

ecyrbe commented Feb 13, 2023

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

@GavinMeierSonos
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants