Alternative docs theme experiment (with builtin dark mode)

[liborjelinek]

Hi,
I’ve been using Syncthing recently and spent some time browsing the documentation. I noticed the docs are still using an older Sphinx theme, which is, of course, completely fine and functional. But I have also noticed a few tickets asking for dark mode.

Recently, I have created a new Clarity theme for Sphinx. Out of curiosity, I made a small fork where I tried rendering the same documentation with the Clarity theme, just as a side experiment.

I’m not suggesting any change, but I thought I’d share the preview in case you find it interesting or useful to look at.

– new docs: https://showcase.readcraft.io/syncthing/ (version switching doesn't work because I have used only the latest version for this experiment)
– fork: https://github.com/ReadCraft-io/showcase-synching

I could send a PR. Or, if this isn’t something you want to consider, feel free to ignore this — I just wanted to share the experiment.

Thanks for creating Syncthing 🙏

[imsodin]

I feel like this is about as close to a PR as it gets, without actually being one :)
Looks nice at a first glance, I personally would certainly not mind a dark theme at least.

I suggest that you do create a PR based on that fork (description/question can stay more or less exactly as this issue imo). Then our CI pipeline will also build and create a viewable version of the docs (without merging). Probably no different from what you linked, but still good to see that it's working with our tooling. And anyone interested can then directly comment on it about any requests for tweaks/changes/... E.g. I am noticing the lack of "Edit on github" link (that might just be because it's a separate instance for now?). If you want a wider discussion not focussed on technical details but more user feedback, I'd suggest you open a topic on the forum .

[tomasz1986]

I only use light themes, and I also think that your version looks quite nice, especially the fact that the whole site is wider, fitting more content horizontally (which is great for longer code lines), and I also like the choice of background colours which more clearly distinguish between different types of content.

The only "annoying" part for me is that the version switch bar at the top loads with a delay that makes the rest of the content jump. The same happens with our current Docs site, but since it loads much faster, the jump is less noticeable.

[liborjelinek]

Thanks for the feedback, guys. I'm going to prepare a PR which will

• add "Edit on GitHub" link
• fix version select