anmonteiro / lumo

Fast, cross-platform, standalone ClojureScript environment
Eclipse Public License 1.0
1.88k stars 84 forks source link

Docs site #338

Open alex-dixon opened 6 years ago

alex-dixon commented 6 years ago

Following up on https://github.com/anmonteiro/lumo/issues/328#issuecomment-350603309

Suggest considering https://docusaurus.io/

You get a lot for free. In my case the most valuable by far is the styling/layout. Getting a web 2.0-ish look like that would take me a while!

Documentation is written in markdown and rendered to HTML.

Looks similar to other sites of popular open source projects that use the same template (React, Relay, etc). Could be a pro or con I guess but overall a positive to me.

Seems easy to use, deploy, and contribute to. I think they provide a script that publishes to gh pages automagically.

Colors, logos etc seem to be customizable pretty easily.

arichiardi commented 6 years ago

This is still a good idea, the content of which, at least in its embryonic form, is now at least visible in the wiki: https://github.com/anmonteiro/lumo/wiki