bengeisler / TcLog

Flexible logging functionality for TwinCAT 3.
MIT License
54 stars 10 forks source link

doc: upgraded to docfx 2.72 modern style #13

Closed iadonkey closed 1 year ago

iadonkey commented 1 year ago

zkdoc was using an outdated version of docfx and we now upgraded to the latest docfx release, the visual style of the documentation is now a bit fresher when you use the modern theme, see https://stefanbesler.github.io/struckig/

you can also use _appLogoUrl in the file "metadata.json" to add a custom logo for a list of all available meta variables in the modern theme see https://dotnet.github.io/docfx/docs/template.html?tabs=modern

bengeisler commented 1 year ago

Hi, thanks for the update! On a desktop browser the new style looks good, but on mobile browsers it seems that the toc is not rendered correctly since it takes more than half of the screen area:

image

Do you have a fix for that?

stefanbesler commented 1 year ago

On my iphone and in firefox development tools it looks pretty good. Is the browser set to force desktop view or sth? The "In this article" should not be visible on mobile devices, but I think that _layout in metadata.json can be used completely disable it. what browser is it?

as a side note: You can override/adjust the css style completely by creating your own template. Instead of "template" you could create a folder called "bentemplate" and use it in "docfx.json" after "modern". The folder has to look like bentemplate/public/main.css In main.css you can tweak the style however you like you can also add a file called main.js to add javascript

bengeisler commented 1 year ago

I tried it both with Arc and Safari on an iPhone 7. Desktop view is not enabled.

For now I'll stick to the old version and maybe update in the future. The current version of the docs is also very legible and fiddling with CSS on the other hand can become quite time consuming :)

iadonkey commented 1 year ago

looks like this on my iphone11 in safari and firefox, but nvm

image

iadonkey commented 1 year ago

FYI, I was able to reproduce the issue on an iPad, reported the bug to docfx https://github.com/dotnet/docfx/issues/9422