Mkdocs-material

[mauwii]

Hi, since I really enyoj this Project I felt the needs to give something back. So hopefully you like the Documentation I created out of your Docs Folder.

Still far away from perfect, but I dont think that the day we see a perfect documentation for a IT Product will come soon - well, at least not untill we have a AI to create them automatically ;P

If you want to see what the Docs look like --> here you go

[lstein]

This is very impressive. Thank you.

I am confused by the new subheadings in the table of contents in README.md. Where are they coming from, and is there any way to indent them? Right now, the TOC iss a mixture of bold and non-bold text and doesn't distinguish the headings from the subheadings well.

[mauwii]

I'm very happy that you like it @lstein ☺️

at the TOC I first need to say: "ooooops" - TOC got created automatically through the VS-Code addon "yzhang.markdown-all-in-one". After I changed the add-on settings to only show h2 headlines, I only "fixed" it in the Repos main README.md, but forgot to fix it in docs/index.md as well 🤦🏻‍♂️

imho the entry page (docs/index.md) should be mostly redesigned, since it is is a completley different situation on MkDocs than on a Repositorys main README.md. But since I did not know if you would even be interested in something like this I did not put too much effort into it 🙈

I just did a qiuck and dirty fix of the docs/index.md, so now the TOC should look better --> click me

[lstein]

On Thu, Sep 15, 2022 at 10:02 AM Matthias Wild ***@***.***> wrote: I'm very happy that you like it :-) at the TOC I first need to say: "ooooops" - TOC got created automatically through the VS-Code addon "yzhang.markdown-all-in-one". After I changed the add-on settings to only show h2 headlines, I only "fixed" it in the Repos main README.md, but forgot to fix it in docs/index.md as well 🤦🏻‍♂️ imho the entry page (docs/index.md) should be mostly redesigned, since it is is a completley different situation on MkDocs than on a Repositorys main README.md. But since I did not know if you would even be interested in something like this I did not put too much effort into it 🙈 I just did a qiuck and dirty fix of the docs/index.md, so now the TOC should look better --> click me <https://mauwii.github.io/stable-diffusion/> — Reply to this email directly, view it on GitHub <#575 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAA3EVJ3R4CCLLSV7HZHT3DV6MT7NANCNFSM6AAAAAAQMXDNKI> . You are receiving this because you commented.Message ID: ***@***.***>

Very nice indeed. I'll go ahead and merge your work into the "development" branch. It will appear in main the next time we do a release. I expect this to be in about a week. Lincoln

[lstein]

Thank you for all the work you put into this. The docs look great.

[mauwii]

Well, thank you sir, @lstein (and of course all the other contributors!!!) for all your effort 🧐

You need to enable GH-Pages for it to work, this is what my configuration looks like atm:

[tildebyte]

@lstein; Enabling GH Pages is a fantastic idea. We can link to them from the main repo README, enhancing discoverability, and have much nicer looking docs as well. I imagine that the docs will only grow in size and complexity; having a web of .md files won't cut it much longer

[Any-Winter-4079]

@tildebyte Is it enabled yet? If so, how do you access it? (I mean, I can see the website https://mauwii.github.io/stable-diffusion/ but how do you access it from this repo?). If it's not enabled yet, maybe we should re-ping lstein or give this visibility in a PR that's not closed so it's not missed.

[tildebyte]

@Any-Winter-4079; Let's give @lstein at least 24 hours :D

[mauwii]

I guess it will happen, as mentioned, with the next Release 🙈
I changed the url and other stuff in this PR to point to lstein's gh-pages and they will be built automatically as soon as a push/merge to main happens 🤓