From 3dd798dc1a3c102157127bbced17f6f53b88dc8e Mon Sep 17 00:00:00 2001 From: Thomas Mello Date: Wed, 28 Sep 2022 14:18:56 +0300 Subject: [PATCH] chore: update docs (#1351) * added front matter * fixed links * logo is removed until further consideration --- README.md | 6 +++--- docs/1.windows-installation.md | 9 ++++----- docs/2.linux-installation.md | 7 ++++--- docs/3.docker-guide.md | 5 +++-- docs/4.streamlit-interface.md | 8 ++++---- docs/5.gradio-interface.md | 7 ++++--- docs/6.image_enhancers.md | 6 ++++-- docs/8.custom-models.md | 4 +++- 8 files changed, 29 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index bba8c7c..aab5c3f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -![](images/sd-wui_logo.png) +#
Web-based UI for Stable Diffusion
-#
Web-based UI for Stable Diffusion by [sd-webui](https://github.com/sd-webui)
+## Created by [sd-webui](https://github.com/sd-webui) ## [Visit sd-webui's Discord Server](https://discord.gg/gyXNe4NySY) [![Discord Server](https://user-images.githubusercontent.com/5977640/190528254-9b5b4423-47ee-4f24-b4f9-fd13fba37518.png)](https://discord.gg/gyXNe4NySY) ## Installation instructions for: -- **[Windows](https://sd-webui.github.io/stable-diffusion-webui/docs/1.installation.html)** +- **[Windows](https://sd-webui.github.io/stable-diffusion-webui/docs/1.windows-installation.html)** - **[Linux](https://sd-webui.github.io/stable-diffusion-webui/docs/2.linux-installation.html)** diff --git a/docs/1.windows-installation.md b/docs/1.windows-installation.md index 01ff3d8..2dbc2cf 100644 --- a/docs/1.windows-installation.md +++ b/docs/1.windows-installation.md @@ -1,3 +1,6 @@ +--- +title: Windows Installation +--- -# Windows Installation - -[To install on Linux, see this page.](https://github.com/sd-webui/stable-diffusion-webui/blob/master/docs/2.linux-installation.md) - -# Windows - step by step Installation guide # Initial Setup +> This is a windows guide. [To install on Linux, see this page.](2.linux-installation.md) ## Pre requisites diff --git a/docs/2.linux-installation.md b/docs/2.linux-installation.md index eee1d46..fff6f7b 100644 --- a/docs/2.linux-installation.md +++ b/docs/2.linux-installation.md @@ -1,3 +1,6 @@ +--- +title: Linux Installation +--- -# Linux Installation - ### The definitive Stable Diffusion WebUI experience ™ Now 100% Linux Compatible! #### Created by [Joshua Kimsey](https://github.com/JoshuaKimsey) -[To install on Windows, see this page.](https://github.com/sd-webui/stable-diffusion-webui/blob/master/docs/1.windows-installation.md) +> This is a Linux guide. [To install on Windows, see this page.](1.windows-installation.md) **Note: This guide describes how to use the automated installation script created by [Joshua Kimsey](https://github.com/JoshuaKimsey). It is my personal recommendation to use this script as it will automatically handle downloading and updating the repo for you. This is not a requirement to running the Stable Diffusion WebUI on Linux, but you will need to install your own conda environment manually and then run `webui.sh` to run the Stable Diffusion WebUI.** diff --git a/docs/3.docker-guide.md b/docs/3.docker-guide.md index 661483d..4ad5b25 100644 --- a/docs/3.docker-guide.md +++ b/docs/3.docker-guide.md @@ -1,3 +1,6 @@ +--- +title: Running Stable Diffusion WebUI Using Docker +--- -# Running Stable Diffusion WebUI Using Docker - This Docker environment is intended to speed up development and testing of Stable Diffusion WebUI features. Use of a container image format allows for packaging and isolation of Stable Diffusion / WebUI's dependencies separate from the Host environment. You can use this Dockerfile to build a Docker image and run Stable Diffusion WebUI locally. diff --git a/docs/4.streamlit-interface.md b/docs/4.streamlit-interface.md index d332b23..0054113 100644 --- a/docs/4.streamlit-interface.md +++ b/docs/4.streamlit-interface.md @@ -1,3 +1,6 @@ +--- +title: Streamlit Web UI Interface +--- - -# Streamlit Web UI Interface - **Features:** - Clean UI with an easy to use design, with support for widescreen displays. - Dynamic live preview of your generations @@ -111,4 +111,4 @@ TBD *This section of the Web UI is still in development* -This area allows you to custmoize how you want Streamlit to run. These changes will be saved to `configs/webui/userconfig_streamlit.yaml`. \ No newline at end of file +This area allows you to custmoize how you want Streamlit to run. These changes will be saved to `configs/webui/userconfig_streamlit.yaml`. diff --git a/docs/5.gradio-interface.md b/docs/5.gradio-interface.md index 6a34bb4..3bfdb6f 100644 --- a/docs/5.gradio-interface.md +++ b/docs/5.gradio-interface.md @@ -1,3 +1,6 @@ +--- +title: Gradio Web UI Interface +--- -# Gradio Web UI Interface - ### Gradio Web UI Features: - Older UI design that is fully functional and feature complete. - Has access to all upscaling models, including LSDR. @@ -88,7 +89,7 @@ The Gradio Image Lab is a central location to access image enhancers and upscale - LSDR: A 4x upsclaer that uses Latent Diffusion, preserving a lot more detail at the cost of speed and VRAM - GoLatent: Uses LSDR to do a 4x upscale, then GoBig to make a final 8x upscale with great detail preservation. -Please see the [Image Enhancers](https://github.com/sd-webui/stable-diffusion-webui/blob/master/docs/6.image_enhancers.md) section to learn more about how to use these tools. +Please see the [Image Enhancers](6.image_enhancers.md) section to learn more about how to use these tools. ## Gradio Optional Customizations diff --git a/docs/6.image_enhancers.md b/docs/6.image_enhancers.md index b14066b..e92982e 100644 --- a/docs/6.image_enhancers.md +++ b/docs/6.image_enhancers.md @@ -1,3 +1,6 @@ +--- +title: Upscalers +--- -# **Upscalers** Included with both versions of the Web UI Interface are a series of image restorers and upscalers. They are included to help users create outputs with restored features, such as better faces, or at larger resolutions than Stable Diffusion is able to natively output. @@ -68,4 +70,4 @@ To use GoLatent, you will need to download the appropriate LSDR models as descri ## Future Additions -Currently, these are the 4 main enhancers and upscalers used in the project, but more may be implemented in the future. Stay Tuned! \ No newline at end of file +Currently, these are the 4 main enhancers and upscalers used in the project, but more may be implemented in the future. Stay Tuned! diff --git a/docs/8.custom-models.md b/docs/8.custom-models.md index b05af59..61ad45b 100644 --- a/docs/8.custom-models.md +++ b/docs/8.custom-models.md @@ -1,3 +1,6 @@ +--- +title: Custom models +--- -# Custom models You can use other *versions* of Stable Diffusion, and *finetunes* of Stable Diffusion.