search

openbases / docs

Open Research Experiments
https://openbases.github.io
2 stars 0 forks source link

web site and documentation #3

Closed vsoch closed 6 years ago

vsoch commented 6 years ago

The documentation / website for the templates will eventually live here, so we need a nice generation strategy. @FelixHenninger I really like what you have for LabJS, and actually @jodeleeuw yours too! Should we start with a variation on that?

vsoch commented 6 years ago

feedback wanted! I am working with https://docs.cornerstonejs.org and I consistently find myself thinking "I really like this documentation!" Well it' just this thing called "gitbook" --> https://www.gitbook.com/

Have you guys tried this out, and / or would be open to giving it a try? In that it's integrated with Github, and (the other thing I started working on) is sphinx (and this isn't super friendly if you don't know how to program) I think it might be a good option for us.

vsoch commented 6 years ago

oh eww, 2 users for free, maybe not :P image

jodeleeuw commented 6 years ago

I've been happy with mkdocs (what I use for jspsych). Everything is markdown, so it's very easy for the community to edit docs and submit PRs.

vsoch commented 6 years ago

oh cool! Let me check that one out - I really like your new docs too :) We definitely need a good balance of renders beautifully, but also is easy to contribute to.

vsoch commented 6 years ago

oh I really like this! :)

vsoch commented 6 years ago

Just for color reference --> https://www.materialui.co/colors