search

LisaFC / justdocs

A customized Docsy example site that just has a docs section
Apache License 2.0
23 stars 19 forks source link

Integrating justdocs capabilities into main Docsy? #3

Open garyrob opened 4 years ago

garyrob commented 4 years ago

Hi, Justdocs is just what I need, but I'd like to be using something that is being actively maintained over time. Is it possible that the Justdocs capabilities could be moved into the main Docsy through configuration options?

LisaFC commented 4 years ago

Hi Gary! Glad you like it.

I'm not sure about the feasibility of moving it into a configuration option without significant refactoring - as I said in the original issue where I created it, it basically involved changing the entire site hierarchy to move the docs landing page up to the site index (which has special behaviour/meaning in Hugo). Which is not to say it can't be done but it wouldn't be trivial and isn't something I/the project have bandwidth to deal with right now (ditto making this a fully maintained sibling project to docsy-example).

That said, it's not strictly "unmaintained" in that it still uses the maintained Docsy theme as a submodule, it just overrides the default and sidebar layouts (which haven't changed much since we created the theme), everything else is updatable to the latest Docsy goodness. If you're happy to pop an issue in here if the layouts ever break, go ahead and use it.

I will update it now to the latest version of the theme. :)

LisaFC commented 4 years ago

(Obviously you can update your own copy to the latest version of the theme whenever you like...)

garyrob commented 4 years ago

OK, Lisa, thank you for helping me understand the situation!

di9383 commented 2 years ago

Hi @LisaFC. Just to heads up. Theme wasn't updated last time you were planning to do so :) And 'justdocs' doesn't get built with up-to-date Docsy theme. Are you planning to support this fork somehow or it is better not to rely on it and use Docsy instead?

Updated. Oh, my bad. I've missed that this issue was raised a year ago :) But the rest of the question is still valid, thank you!

LisaFC commented 2 years ago

Hi there! So I have good news - with newer Hugo, you can actually now do more or less what this highly customized project does with the original Docsy theme. See instructions and example here: https://www.docsy.dev/docs/adding-content/content/#alternative-site-structure https://github.com/gwatts/mostlydocs/

I'm going to remove links to (and possibly retire, or at least update the README) this theme as the new way to do this is nicer and actually maintained.