Docs setup

[m10rten]

Documentation website could be created with docusaurus.

Make sure to use TS.

Read below for details(docusaurus is not a must).

[m10rten]

Docusaurus is ehat I think is easy to setup and future proof once setup correctly.

Please comment under this if you have any other sollution.

Requirements:

• must use typescript
• must be ready for future features/functions/projects
• must be good and clean looking for simplest UX and DevX when reading docs.
• could have a dark/light theme options.
• could have code block options
• must use markdown or equivalent.

[adlaonmd]

I agree with Docusaurus. Looks pretty simple to setup and good for the long run. We should start the initial setup to get things going.

[m10rten]

I agree with Docusaurus. Looks pretty simple to setup and good for the long run. We should start the initial setup to get things going.

Yes, for sure.

When I have the time I will create the basic initial docusaurus setup, nothing more.

Or if anyone else has time to do so, create a PR on the dev branch(if it doesnt exist on time of PR, please notify me again)

[m10rten]

Simply created dev.

[adlaonmd]

I can do the initial Docusaurus setup.

[m10rten]

I can do the initial Docusaurus setup.

Alright 💪 I will be very critical on the initial setup since its going for a long run. Dont take my critics as bad, but only as project stability (if I have any feedback at all ✌️😅).

[m10rten]

@adlaonmd create a PR and assign me so I get notified.

[m10rten]

I just tried out the qwik documentation setup, its under setup/qwik in /qwik.

Its solid, but requires a lot of own design I think. What also gives a lot of config options, which you don't have with docusaurus.

So it made me doubt....

[m10rten]

Did the same for Astro in setup/astro, not a succes if you ask me.

search engine is OK, but you need to set it up without documentation given. site looks sloppy and the file are in .astro endings... Rating: not so well.

[m10rten]

https://vercel.com/templates/next.js/documentation-starter-kit

Looking into this tuesday when I have time. seems nice.(nextjs biased a bit)

[adlaonmd]

Nextra is not production ready though so it doesn't meet the future proof criteria which is essential.

[m10rten]

https://nextjs.org/blog/markdown

Then perhaps we should look into creating our own version. Perhaps another project: documentation generator.

[adlaonmd]

Your call. Whichever seems feasible.

[m10rten]

I am a big NextJS fan, making it yourself is also good for config options etc.

Everyone involved gets to speak their mind, so what do you think?

[adlaonmd]

I'm a fan of Next.js too so it's not an issue. It's also a great learning opportunity to create another project from scratch, but this time with other people involved.

[m10rten]

I'm a fan of Next.js too so it's not an issue. It's also a great learning opportunity to create another project from scratch, but this time with other people involved.

Alright, I will setup the project and create a new one: jv-doc.

To create a doc website with markdown on top of react websites.