mauwii
badf4e256c
enable navigation tabs
...
Since the docs are growing, this way they look cleaner
2022-11-06 09:27:59 -08:00
mauwii
1c687d6d03
more updates to many docs, including:
...
- better readability in dark mode since color change
- better looking changelog
- fix images which where not loading
- also center most of the images
- fix some syntax errors like
- headlines ending with a colon
- codeblocks with wrong fences
- codeblocks without shell
- update conda prompts from ldm to invokeai
- ....
2022-10-11 21:41:52 -04:00
Lincoln Stein
79e79b78aa
mkdocs fixes, PR #1032
...
Squashed commit of the following:
commit 2c1e0168bb03a2cd625f2d4aca40eee0fdf7e4af
Merge: 2325c6c 31f2733
Author: Lincoln Stein <lincoln.stein@gmail.com>
Date: Tue Oct 11 08:33:18 2022 -0400
Merge branch 'mkdocs-fixes' of https://github.com/mauwii/stable-diffusion into mauwii-mkdocs-fixes
commit 31f2733e898a9885afbb9c1e2b023cd08193767a
Merge: d9d6d3a a61a690
Author: Lincoln Stein <lincoln.stein@gmail.com>
Date: Tue Oct 11 08:05:52 2022 -0400
Merge branch 'main' into mkdocs-fixes
commit d9d6d3af3f0423e196ff7245a7c7d408bdab0fdd
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 08:13:04 2022 +0200
some more minor, overseen fixes to IMG2IMG
commit 4ab5a2aebac65f9f59f35f0ae10ece1741bb70d8
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 07:49:11 2022 +0200
add 4gotten alt-text to images
commit f778bd9c0f751699c215f2035c189b95647ddc83
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 07:18:11 2022 +0200
update OTHER.md
- fix codeblocks, add admonitions, embed graphic
commit a19f148a8eff910ff1c565bd24863a53dcad68e2
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 06:51:29 2022 +0200
update IMG2IMG.md
commit c1f1dfa714c9f93a1ff34f9773e438db5f88c83c
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 06:10:25 2022 +0200
update EMBIGGEN.md
- fix codeblocks
- fix toc
- use admonitions
commit 791e6c63ef29934c5b2692794a3825ef129fad0c
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 05:58:53 2022 +0200
better admonitions for CLI.md
commit e078025f002dc50d4942524e18e6cf44989c2bab
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 05:50:32 2022 +0200
huge update to CLI.md
way too many updates to list them all, including:
- render keys for keyboard-shortcuts
- quote commands and "unhide" parameter-values (like `<int>`, `<string>`
- fix codeblocks
- quote commands
- quote filenames
- use admonitions
- ....
commit bd98dd2307a461c15291e44f3bfb224a1aeb5819
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 04:49:57 2022 +0200
fix INPAINTING.md
- fix numbered List
- replace text key combos with actual rendered keyboard keys
commit 53920003352b6eaa867b2234594dfa504426323b
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 04:30:11 2022 +0200
fix nubered list and codeblocks in INSTALL_WINDOWS
commit ffe9276f1e59b97fa786e92d457a2f37126bb4ef
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 04:12:56 2022 +0200
fix numbered list in INSTALL_LINUX.md
also fix blank lines, codeblocks and admonition
commit 2c6a6a567f219248c60106de641764a855b54c84
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 03:51:03 2022 +0200
upgrade INSTALL_MAC.md:
- use annotations and content-tabs
yes, this looks ugly in repo afterwards, but plz also look at mkdocs:
https://mauwii.github.io/stable-diffusion/installation/INSTALL_MAC/
commit 8f6c54448044f7156612f5949177607aca253441
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 01:43:11 2022 +0200
comment out PR part in mkdocs-flow.yml
commit b52c14a67ffadd972f0da04fe3b66fa2300449e5
Merge: 97ebe58 a1b0b91
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 01:17:28 2022 +0200
Merge branch 'mkdocs-fixes' of github.com:mauwii/stable-diffusion into mkdocs-fixes
commit a1b0b91bb3d24cfc68304b717c3c6b2344d4ee4e
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:59:44 2022 +0200
fix conda env in codeblock
commit 5f9f9a266e070a84787667cd3fb18a87ad976c32
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:43:46 2022 +0200
fix 4gotten title in TEXTUAL_INVERSION
commit 8f025b034ec0b8c637d1b57a07b8e187b01b158e
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:41:52 2022 +0200
quote repo_url and repo_name
otherwise the version/stars/forks did not appear
commit 3a52b7deb340ba7d92601f8369f2a35d486cab88
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:39:54 2022 +0200
fix TEXTUAL_INVERSION headline to fit the others
commit 389b21f966cba769de548e30983cd55860e54bc4
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:35:48 2022 +0200
fix SAMPLER_CONVERGENCE and add emoji
commit f26fc79a18ef17a03569dfe5ccb5987d7f346764
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:32:04 2022 +0200
fix INSTALL_DOCKER.md:
- fix title (Docker instead of "Before you begin")
- add headline with Emoji
- fix headlines to render toc correct
commit cbc352048901447e3be4ac6a9dc8c78cbf74cb38
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:24:58 2022 +0200
add headline with emoji to INSTALL_MAC.md
commit 25f0614d66c7dcdb60aa1c6fccc32c831d348d69
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:21:01 2022 +0200
add log emoji to docs/CHANGELOG.md
commit 42005688fa3ad59af04c2a4ed198a943fa53f6b5
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:20:47 2022 +0200
use better fitting Icon for new Name
commit 0c65bad7f52152a5e264bf2b8509925350350e92
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:09:07 2022 +0200
add Headline with Emoji to WEB and POSTPROCESS
commit 1c1cf2692ea8ec4fbbc9a3c910ef8e285d149201
Author: mauwii <Mauwii@outlook.de>
Date: Mon Oct 10 23:56:16 2022 +0200
update index.md:
- remove unused template reference
- make headline rendered bold and underlined, add (kind of) subtitle
- update discord badge and link
- update Quick links to look like in GH-Readme
- also remove self reference to docs
- add screenshot as in GH-Readme
- add note pointing to issues tab
- update path in command line to reflect new Repo Name
commit 0e29b0737edd1ef3d22dc808297174100c6de3c2
Author: mauwii <Mauwii@outlook.de>
Date: Mon Oct 10 23:23:10 2022 +0200
chng site_name to `Stable Diffusion Toolkit Docs`
commit ad8a60d9927be9b4f1e056116cb9f38c30b840d6
Author: mauwii <Mauwii@outlook.de>
Date: Mon Oct 10 23:00:02 2022 +0200
fix repo_url in mkdocs.yml
commit 234569d6b6cfd2d9775a2d5d8f8b951f3d8f5ff4
Author: mauwii <Mauwii@outlook.de>
Date: Mon Oct 10 22:54:39 2022 +0200
fix link to upscaling in WEB.md and TOC
- TOC fixed by adding `#` to every headline after `## Parting remarks`
- add missing blank lines
commit 97c84ad82433b4b07b4c1908656763be8eb28b5b
Author: mauwii <Mauwii@outlook.de>
Date: Mon Oct 10 22:25:32 2022 +0200
fix broken links in docs/CHANGELOG.md
commit bce62b3a32a839fa07b41b11cadd04dff2d9f7dd
Author: mauwii <Mauwii@outlook.de>
Date: Mon Oct 10 22:15:37 2022 +0200
add title to CHANGELOG.md to render TOC wo. `**`
alternatively remove `**` around headline
commit 97ebe58b5bcfe4706386d79f26953b665c5c3251
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:59:44 2022 +0200
fix conda env in codeblock
commit 87ac217e43bf2a0293c1aa8b1894281d1b298084
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:43:46 2022 +0200
fix 4gotten title in TEXTUAL_INVERSION
commit 91439e8a52a918d9590830592f4f114bb44b47f0
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:41:52 2022 +0200
quote repo_url and repo_name
otherwise the version/stars/forks did not appear
commit 8a632a9e8fad884b99f54df8e0dc983552ce48eb
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:39:54 2022 +0200
fix TEXTUAL_INVERSION headline to fit the others
commit 7c8ffe2febd84faba1f7be0456d39ad9569239dc
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:35:48 2022 +0200
fix SAMPLER_CONVERGENCE and add emoji
commit e2e86d2d11b641c7f0dd713e2074083df2b902bc
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:32:04 2022 +0200
fix INSTALL_DOCKER.md:
- fix title (Docker instead of "Before you begin")
- add headline with Emoji
- fix headlines to render toc correct
commit 8b54c083fec0b05c965db40f9f2634662b26acd3
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:24:58 2022 +0200
add headline with emoji to INSTALL_MAC.md
commit 8d8a03243470281c3098cd77a8183ec62506d820
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:21:01 2022 +0200
add log emoji to docs/CHANGELOG.md
commit 76519f6fa475c9507e2deb037c7c27f08d96c14f
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:20:47 2022 +0200
use better fitting Icon for new Name
commit aff0725533324db359ad801bbc74d2478caae853
Author: mauwii <Mauwii@outlook.de>
Date: Tue Oct 11 00:09:07 2022 +0200
add Headline with Emoji to WEB and POSTPROCESS
commit 0f7898cbdd13cd48ee88eae6349adbc0bde344ce
Author: mauwii <Mauwii@outlook.de>
Date: Mon Oct 10 23:56:16 2022 +0200
update index.md:
- remove unused template reference
- make headline rendered bold and underlined, add (kind of) subtitle
- update discord badge and link
- update Quick links to look like in GH-Readme
- also remove self reference to docs
- add screenshot as in GH-Readme
- add note pointing to issues tab
- update path in command line to reflect new Repo Name
commit f4c04eadf83e29f28a9919b78cc3583465bd1939
Author: mauwii <Mauwii@outlook.de>
Date: Mon Oct 10 23:23:10 2022 +0200
chng site_name to `Stable Diffusion Toolkit Docs`
commit 6e624827c02af2c5f3ac2c64e137355fd6dcab1e
Author: mauwii <Mauwii@outlook.de>
Date: Mon Oct 10 23:00:02 2022 +0200
fix repo_url in mkdocs.yml
commit 158848dd7edcea2a41a90c457faf00f0247784d2
Author: mauwii <Mauwii@outlook.de>
Date: Mon Oct 10 22:54:39 2022 +0200
fix link to upscaling in WEB.md and TOC
- TOC fixed by adding `#` to every headline after `## Parting remarks`
- add missing blank lines
commit 533736e135a62dabc2dc937f6b81c5929d245b12
Author: mauwii <Mauwii@outlook.de>
Date: Mon Oct 10 22:29:46 2022 +0200
fix link to truncation_comparison.jpg in OTHER.md
commit dd335142df32410590e03917a6f0b4a6879bbbdb
Author: mauwii <Mauwii@outlook.de>
Date: Mon Oct 10 22:25:32 2022 +0200
fix broken links in docs/CHANGELOG.md
commit 374dd54f30e946cf856d59ebe530d819dd34b822
Author: mauwii <Mauwii@outlook.de>
Date: Mon Oct 10 22:15:37 2022 +0200
add title to CHANGELOG.md to render TOC wo. `**`
alternatively remove `**` around headline
2022-10-11 08:36:00 -04:00
Lincoln Stein
5c3fad22fd
Update mkdocs.yml
...
Changed owner and repo name
2022-10-10 11:11:06 -04:00
mauwii
676c772f11
update mkdocs config
...
- use git-revision-date-localized with enabled creation date
- update requirements-mkdocs.txt and pin verisons
- add requirements
- add dev addr
- fix template
- use better icons for repo and edit button
- remove odd extension
2022-09-18 11:12:45 +02:00
mauwii
98f189cc69
fix username for magiclinks to point to lstein
2022-09-18 06:43:50 +02:00
mauwii
d8d30ab4cb
separate toc by disabling toc.integrate
...
this way the leftside menu does not look so bloated and users can
find what they are looking for much faster
2022-09-17 02:08:37 +02:00
Matthias Wild
ec2dc24ad7
Mkdocs-material ( #575 )
...
* Squashed commit of the following:
commit 82d9c25d9a87ea5f6fbdb0445313e48cd8ae3035
Author: mauwii <Mauwii@outlook.de>
Date: Wed Sep 14 19:29:11 2022 +0200
fix branch name in mkdocs-flow
commit 2e276cecc1942050ae8b22f4a417c576c49763a1
Author: mauwii <Mauwii@outlook.de>
Date: Wed Sep 14 19:28:35 2022 +0200
fix theme name
commit 2eb77c1173598e161e8a5a9812b021b831363183
Author: mauwii <Mauwii@outlook.de>
Date: Wed Sep 14 19:14:42 2022 +0200
fixed some links and formating in main README
commit 66a7152e48e8c66c9286f47a6b088920a8fcdcd8
Author: mauwii <Mauwii@outlook.de>
Date: Wed Sep 14 08:58:58 2022 +0200
trigger mkdocs deployment on main
commit 897cc373ce4f9d18d8cb2837b5931c4b674c836b
Merge: 89da371 3b5a830
Author: Matthias Wild <40327258+mauwii@users.noreply.github.com>
Date: Wed Sep 14 07:51:23 2022 +0200
Merge pull request #1 from mauwii/mkdocs
Mkdocs
commit 3b5a8308eb6b7ee572ff07f78829f64bcf55b4d9
Author: mauwii <Mauwii@outlook.de>
Date: Wed Sep 14 07:42:56 2022 +0200
huge update
I was pretty busy trying to make the Readmes / docs look good in MkDocs
commit 0b4f5a926ff8aad1460e0be8093ee02d719a576d
Author: mauwii <Mauwii@outlook.de>
Date: Wed Sep 14 07:41:45 2022 +0200
update mkdocs config
commit 872172ea7008aa1217c1259c7ecab16ddafd1a0e
Author: mauwii <Mauwii@outlook.de>
Date: Wed Sep 14 07:33:49 2022 +0200
added the mkdocs-git-revision-date-plugin
commit eac81bf87588ec88b65f3415aa838c330fbd621b
Author: mauwii <Mauwii@outlook.de>
Date: Wed Sep 14 06:46:43 2022 +0200
add prettier config
remove markdownlint
move and rename requirements-mkdocs.txt
commit b36d4cc088a49af56026aa2dd2e85d6bfb181bd1
Author: mauwii <Mauwii@outlook.de>
Date: Wed Sep 14 02:06:39 2022 +0200
add dark theme
commit a14f18fede6febccf1c117cba50a1aff1eac80a9
Author: mauwii <Mauwii@outlook.de>
Date: Wed Sep 14 01:38:02 2022 +0200
update mkdocs flow and config
commit 2764b48693ed382bc01a2cb7aab282dbf95cd9ee
Author: mauwii <Mauwii@outlook.de>
Date: Wed Sep 14 01:15:33 2022 +0200
add mkdocs workflow
commit 1bd22523b1a52ac24bc5f950debb450f903c2d51
Author: mauwii <Mauwii@outlook.de>
Date: Wed Sep 14 00:57:37 2022 +0200
I already begun with formating / revising the sites
* change repository in mkdocs config to lstein
* adapt changes from repos main README.md
Co-authored-by: Lincoln Stein <lincoln.stein@gmail.com>
2022-09-15 10:53:41 -04:00