eco-infra / ecoinfra

Emission prediction tool
https://eco-infra.com
Apache License 2.0
6 stars 3 forks source link

Docs Site #29

Closed rickwysocki closed 1 month ago

rickwysocki commented 5 months ago

It would be useful to run a documentation site out of the /docs folder. This should be easy to do using GitHub pages. There are a few different tools that would make sense:

If this seems like an interesting idea, it would be useful to both pick a tool and also put together a list of content pages that would be needed in the documentation.

iamdavidmt commented 5 months ago

Love it - I think I'm in favour of jekyll considering its effort to setup seems small - I can have a look at getting something setup this weekend.

rickwysocki commented 5 months ago

Cool! Yes, Jekyll is very easy to get going. If you'd like, I'm happy to push my test Jekyll setup in the repository in a separate branch/pull request for you to take a look at, but I totally understand if you'd like to handle it on your end. Either way, I do believe you'll need to configure the GitHub pages side of things on your end.

iamdavidmt commented 1 month ago

Thanks for all the work @rickwysocki - long overdue fix but I've resolved the gem issue by using a remote_theme isntead;