Improved the documentation site by adding extra information on several pages.

blog/2021-08-26-welcome/index.md

@@ -1,25 +0,0 @@
----
-slug: welcome
-title: Welcome
-authors: [slorber, yangshun]
-tags: [facebook, hello, docusaurus]
----
-
-[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
-
-Simply add Markdown files (or folders) to the `blog` directory.
-
-Regular blog authors can be added to `authors.yml`.
-
-The blog post date can be extracted from filenames, such as:
-
-- `2019-05-30-welcome.md`
-- `2019-05-30-welcome/index.md`
-
-A blog post folder can be convenient to co-locate blog post images:
-
-![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
-
-The blog supports tags as well!
-
-**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.

docs/1.Installation/1.one-click-installer.md

@@ -0,0 +1,23 @@
+# Installer
+
+---
+
+### Sygil WebUI
+
+Home Page: https://github.com/Sygil-Dev/sygil-webui
+
+### Installation on Windows:
+
+- Clone or download the code from the [Repository](https://github.com/Sygil-Dev/sygil-webui).
+
+- Double-click the `installer/install.bat` file and wait for it to handle everything for you. 
+
+### Installation on Linux:
+
+- Clone or download the code from the [Repository](https://github.com/Sygil-Dev/sygil-webui).
+
+- Open a terminal on the folder where the code is located and run `./installer/install.sh` ,make sure it has the right permissions and can be executed.
+
+- Wait for the installer to handle everything for you.
+
+After installation, you can run the `webui.cmd` file (on Windows) or `webui.sh` file (on Linux/Mac) to start the WebUI.

docs/1.Installation/2.windows-installation.md

@@ -1,6 +1,5 @@
 ---
-
-title: Windows Installation
+title: Manual Windows Installation
 ---
 
 <!--

docs/1.Installation/3.linux-installation.md

@@ -1,6 +1,7 @@
 ---
-title: Linux Installation
+title: Manual Linux Installation
 ---
+
 <!--
 This file is part of sygil-webui (https://github.com/Sygil-Dev/sygil-webui/).
 
@@ -20,6 +21,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
 ### The definitive Stable Diffusion WebUI experience ™ Now 100% Linux Compatible!
+
 #### Created by [Joshua Kimsey](https://github.com/JoshuaKimsey)
 
 > This is a Linux guide. [To install on Windows, see this page.](1.windows-installation.md)
@@ -27,15 +29,17 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 **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.**
 
 ## Features
+
 - Automates the process of installing and running hlky's fork of Stable Diffusion with the WebUI for Linux-based OS users.
 - Handles updating from the hlky fork automatically if the users wishes to do so.
 - Allows the user to preset their configs for running their setup (Gradio version only).
 
 ## Initial Start Guide
+
 **Note:** This guide assumes you have installed Anaconda already, and have it set up properly. If you have not, please visit the [Anaconda](https://www.anaconda.com/products/distribution) website to download the file for your system and install it.
 
 **WARNING: Multiple Linux users have reported issues using this script, and potentially Stable Diffusion in general, with Miniconda. As such, I can not recommend using it due to these issues with unknown causes. Please use the full release of Anaconda instead.**
- 
+
 **Step 1:** Create a folder/directory on your system and place this [script](https://github.com/JoshuaKimsey/Linux-StableDiffusion-Script/blob/main/linux-sd.sh) in it, named `linux-sd.sh`. This directory will be where the files for Stable Diffusion will be downloaded.
 
 **Step 2:** Download the 1.4 AI model from HuggingFace (or another location, the original guide has some links to mirrors of the model) and place it in the same directory as the script.
@@ -49,11 +53,11 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 **If you are running low on storage space, you can just move the 1.4 AI models file directly to this directory, it will not be deleted, simply moved and renamed. However my personal suggestion is to just **copy** it to the repo folder, in case you desire to delete and rebuild your Stable Diffusion build again.**
 
 **Step 6:** Next, the script will ask if you wish to customize any of the launch arguments for the Gradio WebUI Interface. If yes, then a series of options will be presented to the user:
-	- Use the CPU for Extra Upscaler Models to save on VRAM
-	- Automatically open a new browser window or tab on first launch
-	- Use Optimized mode for Ultimate Stable Diffusion, which only requires 4GB of VRAM at the cost of speed
-	- Use Optimized Turbo which uses more VRAM than regular optimized, but is faster (Incompatible with regular optimized mode)
-	- Open a public xxxxx.gradi.app URL to share your interface with others (Please be careful with this, it is a potential security risk)
+    - Use the CPU for Extra Upscaler Models to save on VRAM
+    - Automatically open a new browser window or tab on first launch
+    - Use Optimized mode for Ultimate Stable Diffusion, which only requires 4GB of VRAM at the cost of speed
+    - Use Optimized Turbo which uses more VRAM than regular optimized, but is faster (Incompatible with regular optimized mode)
+    - Open a public xxxxx.gradi.app URL to share your interface with others (Please be careful with this, it is a potential security risk)
 
 The user will have the ability to set these to yes or no using the menu choices.
 
@@ -64,17 +68,17 @@ The user will have the ability to set these to yes or no using the menu choices.
 **Building the Conda environment may take upwards of 15 minutes, depending on your network connection and system specs. This is normal, just leave it be and let it finish. If you are trying to update and the script hangs at `Installing PIP Dependencies` for more than 10 minutes, you will need to `Ctrl-C` to stop the script, delete your `src` folder, and rerun `linux-sd.sh` again.**
 
 **Step 8:** Once the conda environment has been created and the upscaler models have been downloaded, then the user is presented with a choice to choose between the Streamlit or Gradio versions of the WebUI Interface. 
-	- Streamlit: 
-		- Has A More Modern UI
-		- More Features Planned
-		- Will Be The Main UI Going Forward
-		- Currently In Active Development
-		- Missing Some Gradio Features
+    - Streamlit: 
+        - Has A More Modern UI
+        - More Features Planned
+        - Will Be The Main UI Going Forward
+        - Currently In Active Development
+        - Missing Some Gradio Features
 
-	- Gradio:
-		- Currently Feature Complete
-		- Uses An Older Interface Style
-		- Will Not Receive Major Updates
+    - Gradio:
+        - Currently Feature Complete
+        - Uses An Older Interface Style
+        - Will Not Receive Major Updates
 
 **Step 9:** If everything has gone successfully, either a new browser window will open with the Streamlit version, or you should see `Running on local URL:  http://localhost:7860/` in your Terminal if you launched the Gradio Interface version. Generated images will be located in the `outputs` directory inside of `sygil-webui`. Enjoy the definitive Stable Diffusion WebUI experience on Linux! :)
 
@@ -90,4 +94,5 @@ If the user chooses to Customize their setup, then they will be presented with t
 ### Refer back to the original [WebUI Github Repo](https://github.com/Sygil-Dev/sygil-webui) for useful tips and links to other resources that can improve your Stable Diffusion experience
 
 ## Planned Additions
+
 - Investigate ways to handle Anaconda automatic installation on a user's system.

docs/2.Streamlit/1.streamlit-interface.md

@@ -0,0 +1,132 @@
+# Streamlit Web UI Interface
+
+## Features:
+
+- Clean and easy to use UI: A clean and simple UI with an easy to use design.
+
+- Support for widescreen displays.
+
+- Dynamic Image Preview: This allows you to see how your image is looking during the generation process in real time or near real time (no more waiting until the end to see your image).
+
+- Stop Button: A stop button to stop your generation mid-way if you do not like how your result is looking based on the image preview.
+
+- An integrated gallery to show the generations for a prompt or session (Coming soon!)
+
+- Better optimization VRAM usage optimization, less errors for bigger generations.
+
+- Ability to load and use almost any `ckpt` models or model from HuggingFace.
+
+- Text2Video: Generate video clips from text prompts right from the Web UI thanks to Diffusion Walk.
+
+- Concepts Library: Easy to browse and use textual inversion library of custom embeddings others people (or yourself) have made via textual inversion.
+
+- Textual Inversion: Allow you to create your own embeddings from images and use them in the UI.
+
+- Actively being developed with new features being added and planned - Stay Tuned!
+
+- Streamlit is now the new primary UI for the project moving forward.
+
+- *Currently in active development but still missing some of the features present in the Gradio Interface (Post-Processing tab).*
+
+---
+
+## Text To Image
+
+![](../../images/streamlit/streamlit-t2i.png)
+
+Streamlit Text2Image allows for a modern, but well known, Stable Diffusion Textual Image generation experience. Here is a quick description of some of the features of Text2Image and what they do:
+
+- Width and Height: Control the size of the generated image (Default is 512px)
+- Classifier Free Guidance (CFG): How closely the final image should follow your prompt (Default is 7.5)
+- Seed: The number (or word) used to generate an image with.
+- Images Per Batch: The number of images to generate consecutively (Does not affect VRAM usage)
+- Number of Batches: How many images to generate at once (Very VRAM Intensive)
+- Sampling Steps: The quality of the final output, higher is better (Default is 30)
+- Sampling Method: Which sampler to use to generate the image (Default is `k_euler`)
+
+---
+
+## Image To Image
+
+![](../../images/streamlit/streamlit-i2i.png)
+
+Streamlit Image2Image allows for you to take an image, be it generated by Stable Diffusion or otherwise, and use it as a base for another generation. This has the potential to really enhance images and fix issues with initial Text2Image generations. It also includes some built-in drawing and masking tools to help create custom generations. Some notable features of Gradio Image2Image are:
+
+- Image Editor Mode: Choose whether you wish to mask, crop, or uncrop the image
+- Mask Mode: Allows you to decide if a drawn mask should be generated or kept
+- Denoising Strength: How much of the generated image should replace the original image. (default is 75%)
+- Width and Height: Control the size of the generated image (Default is 512px)
+- Classifier Free Guidance (CFG): How closely the final image should follow your prompt (Default is 7.5)
+- Seed: The number (or word) used to generate an image with
+- Images Per Batch: The number of images to generate consecutively (Does not affect VRAM)
+- Number of Batches: How many images to generate at once (Very VRAM Intensive)
+- Sampling Steps: The quality of the final output, higher is better (Default is 30)
+- Sampling Method: Which sampler to use to generate the image (Default is `k_euler`)
+
+## Text To Video
+
+---
+
+![](../../images/streamlit/streamlit-t2v.png)
+
+The Text2Video tab allow you to generate videos based on a text prompt, it does so by using diffusion walk which generates images using txt2img and then interpolate them in order to walk between prompts or parts of a prompt. As of right now you can only use a single prompt which is then duplicated based on the number of seeds you use.
+
+#### Options:
+
+- Width: The width in pixels for your output image.
+
+- Height: The height in pixels for your output image.
+
+- CFG: How close you want clip to guide the generation toward your prompt.
+
+- Seed: Seed to use during generation, can be an integer, a word or several integers and words separated by comma. When multiple seeds are used the resulting video might be more consistent than when using a single seed.
+
+- Max Duration in Seconds: How long your video should be in seconds.
+
+- Custom Model: A list of models from the HuggingFace website to use, any model hosted on HuggingFace can be used for txt2vid. To add a new model to this list you need to edit the config file on `configs/webui/userconfig_streamlit.yaml`, find the `txt2vid` section and add your model under `custom_models_list`, use other models there for reference on how the format should looks like.
+
+- Sampling Steps: How many steps to perform on an image, this can be seen as the amount of denoising steps performed on the image, higher values mean you get an image with less noise, it also affects the amount of repetition on the image you will get. For higher resolutions with short prompts and long prompts with low resolution you need to increase the number of samplings steps to get a better result, otherwise the amount of repetition on the image will increase exponentially if you use a lower sampling steps value.
+
+- Inference Steps: Extra denoising steps performed between frames/images. This helps make the video more consistent and jump less around, higher values are always better but will make it so the video takes longer for generate.
+
+- Scheduler: Scheduler to use for inference.
+
+- Beta Schedule Type: Scheduler type to use.
+
+## SD Concepts Library
+
+---
+
+![](../../images/streamlit/streamlit-concepts.png)
+
+The Concept Library allows for the easy usage of custom textual inversion models. These models may be loaded into `models/custom/sd-concepts-library` and will appear in the Concepts Library in Streamlit. To use one of these custom models in a prompt, either copy it using the button on the model, or type `<model-name>` in the prompt where you wish to use it.
+
+Please see the [Concepts Library](https://github.com/Sygil-Dev/sygil-webui/blob/master/docs/7.concepts-library.md) section to learn more about how to use these tools.
+
+## Textual Inversion
+
+---
+
+Textual Inversion allows you to create your own embed files training the model in a few images to teach it a new concept based on what is already in the original model, this is fast and do not need too many resources to do so. You can train a new concept to use on the Concepts Library with Textual Inversion, once you finish training it you can then use it on the concepts library.
+
+## Model Manager
+
+---
+
+![](../../images/streamlit/streamlit-model-manager.png)
+
+The Model Manager page allows you to download models with the click of a button, instead of having to go and manually find the link to download a model and then finding where to put it on your disk for the app to detect it we made it so the Model Manager page does most of the heavy lifting for you.
+
+## Tools
+
+This section is a work in progress.
+
+The idea behind it is to provide extra tools for advanced users to do things they need that are not possible with other normal pages. This is intended mainly for developers or technical people wanting to do more than just basic stuff with the UI and even integrating their own things into it.
+
+## Settings
+
+---
+
+![](../../images/streamlit/streamlit-settings.png)
+
+The Settings page allows you to customize how you want Streamlit to run. These changes will be saved to a personalized user setting file in `configs/webui/userconfig_streamlit.yaml`, this file is independent from the defaults file located in `configs/webui/webui_streamlit.yaml` and will not be reset after updates unless a mayor change that would break some options is released, in which case this file will be reset to the defaults values and you would need to configure your settings on the Settings page again. After editing the settings on the Settings page you need to scroll down and hit the `Save` button for it to take effect, you can also use the `Reset` button to reset your settings manually to the defaults in case you made a mistake with any of your settings and you need to reset them, so, feel free to experiment with them and test which settings work best for you and which don't.

docs/3.Gradio/2.gradio-interface.md

@@ -1,25 +1,13 @@
----
-title: Gradio Web UI Interface
----
-<!--
-This file is part of sygil-webui (https://github.com/Sygil-Dev/sygil-webui/).
+# Gradio Web UI Interface
 
-Copyright 2022 Sygil-Dev team.
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
+:::danger Warning
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
+The Gradio WebUI is considered legacy or deprecated, it is no longer being maintained and it lacks several features compared to new versions. Always try to use the most recent version of our UI when possible.
 
-You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
--->
+:::
 
 ### Gradio Web UI Features:
+
 - Older UI design that is fully functional and feature complete.
 - Has access to all upscaling models, including LSDR.
 - Dynamic prompt entry automatically changes your generation settings based on `--params` in a prompt.
@@ -31,20 +19,19 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 To launch the Gradio Web UI, you will need to do the following:
 
 - Windows:
-    - Open your command line in the repo folder and run the `webui.cmd` file.
+  - Open your command line in the repo folder and run the `webui.cmd` file.
 - Linux:
-    - Open your terminal to the repo folder and run `webui.sh`, then press `2` when prompted.
+  - Open your terminal to the repo folder and run `webui.sh`, then press `2` when prompted.
 - Manually:
-    - Open your terminal to the repo folder.
-    - Activate the conda environment using `conda activate ldm`
-    - Run the command `python scripts/relauncher.py`
+  - Open your terminal to the repo folder.
+  - Activate the conda environment using `conda activate ldm`
+  - Run the command `python scripts/relauncher.py`
 
 Once the Gradio Web UI launches, a link will appear in your command line or terminal, click or copy and paste that link into your browser to access the interface.
 
 ## Text2Image
----
 
-![](../images/gradio/gradio-t2i.png)
+![](../../images/gradio/gradio-t2i.png)
 
 Gradio Text2Image allows for the classic and well known Stable Diffusion Textual Image generation. Here is a quick description of some of the features of Text2Image and what they do:
 
@@ -62,7 +49,7 @@ Gradio Text2Image allows for the classic and well known Stable Diffusion Textual
 
 ---
 
-![](../images/gradio/gradio-i2i.png)
+![](../../images/gradio/gradio-i2i.png)
 
 Gradio Image2Image allows for you to take an image, be it generated by Stable Diffusion or otherwise, and use it as a base for another generation. This has the potential to really enhance images and fix issues with initial Text2Image generations. It also includes some built-in drawing and masking tools to help create custom generations. Some notable features of Gradio Image2Image are:
 
@@ -81,7 +68,7 @@ Gradio Image2Image allows for you to take an image, be it generated by Stable Di
 
 ---
 
-![](../images/gradio/gradio-upscale.png)
+![](../../images/gradio/gradio-upscale.png)
 
 The Gradio Image Lab is a central location to access image enhancers and upscalers. Though some options are available in all tabs (GFPGAN and realESRGAN), the Image Lab is where all of these tools may be easily accessed. These upscalers can be used for generated images sent to the lab, or on other images uploaded to it. The tools included here are:
 
@@ -97,7 +84,7 @@ Please see the [Image Enhancers](6.image_enhancers.md) section to learn more abo
 
 ---
 
-![](../images/gradio/gradio-s2i.png)
+![](../../images/gradio/gradio-s2i.png)
 
 Gradio Scene2Image allows you to define layers of images in a markdown-like syntax.
 

docs/4.post-processing.md

@@ -1,5 +1,5 @@
 ---
-title: Upscalers
+title: Post Processing
 ---
 <!--
 This file is part of sygil-webui (https://github.com/Sygil-Dev/sygil-webui/).

docs/4.streamlit-interface.md

@@ -1,120 +0,0 @@
----
-title: Streamlit Web UI Interface
----
-<!--
-This file is part of sygil-webui (https://github.com/Sygil-Dev/sygil-webui/).
-
-Copyright 2022 Sygil-Dev team.
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
--->
-
-**Features:**
-- Clean UI with an easy to use design, with support for widescreen displays.
-- Dynamic live preview of your generations
-- Easily customizable presets right from the WebUI (Coming Soon!)
-- An integrated gallery to show the generations for a prompt or session (Coming soon!)
-- Better optimization VRAM usage optimization, less errors for bigger generations.
-- Text2Video - Generate video clips from text prompts right from the WEb UI (WIP)
-- Concepts Library - Run custom embeddings others have made via textual inversion.
-- Actively being developed with new features being added and planned - Stay Tuned!
-- Streamlit is now the new primary UI for the project moving forward.
-- *Currently in active development and still missing some of the features present in the Gradio Interface.*
-
-### Launching The Streamlit Web UI
-
-To launch the Streamlit Web UI, you will need to do the following:
-
-- Windows:
-    - Open your command line in the repo folder and run the `webui_streamlit.cmd` file.
-- Linux:
-    - Open your terminal to the repo folder and run `webui.sh`, then press `1` when prompted.
-- Manually:
-    - Open your terminal to the repo folder.
-    - Activate the conda environment using `conda activate ldm`
-    - Run the command `python -m streamlit run scripts/webui_streamlit.py`
-
-Once the Streamlit Web UI launches, a new browser tab will open with the interface. A link will also appear in your terminal to allow you to copy and paste it as needed.
-
-## Text2Image
----
-
-![](../images/streamlit/streamlit-t2i.png)
-
-Streamlit Text2Image allows for a modern, but well known, Stable Diffusion Textual Image generation experience. Here is a quick description of some of the features of Text2Image and what they do:
-
-- Width and Height: Control the size of the generated image (Default is 512px)
-- Classifer Free Guidance (CFG): How closely the final image should follow your prompt (Default is 7.5)
-- Seed: The number (or word) used to generate an image with
-- Images Per Batch: The number of images to generate consecutively (Does not affect VRAM)
-- Number of Batches: How many images to generate at once (Very VRAM Intensive)
-- Sampling Steps: The quality of the final output, higher is better with dimiishing returns (Default is 30)
-- Sampling Method: Which sampler to use to generate the image (Default is `k_euler`)
-
-## Image2Image
-
---
-
-![](../images/streamlit/streamlit-i2i.png)
-
-Streamlit Image2Image allows for you to take an image, be it generated by Stable Diffusion or otherwise, and use it as a base for another geenration. This has the potential to really enhance images and fix issues with initial Text2Image generations. It also includes some built-in drawing and masking tools to help create custom generations. Some notable features of Gradio Image2Image are:
-
-- Image Editor Mode: Choose whether you wish to mask, crop, or uncrop the image
-- Mask Mode: Allows you to decide if a drawn mask should be generated or kept
-- Denoising Strength: How much of the generated image should replace the original image. (default is 75%)
-- Width and Height: Control the size of the generated image (Default is 512px)
-- Classifier Free Guidance (CFG): How closely the final image should follow your prompt (Default is 7.5)
-- Seed: The number (or word) used to generate an image with
-- Images Per Batch: The number of images to generate consecutively (Does not affect VRAM)
-- Number of Batches: How many images to generate at once (Very VRAM Intensive)
-- Sampling Steps: The quality of the final output, higher is better (Default is 30)
-- Sampling Method: Which sampler to use to generate the image (Default is `k_euler`)
-
-## Text2Video
-
----
-
-![](../images/streamlit/streamlit-t2v.png)
-
-*Insert details of how to use T2V here*
-(ZeroCool needs to fill in details here of how Text2Video works)
-
-## SD Concepts Library
-
----
-
-![](../images/streamlit/streamlit-concepts.png)
-
-The Concept Library allows for the easy usage of custom textual inversion models. These models may be loaded into `models/custom/sd-concepts-library` and will appear in the Concepts Library in Streamlit. To use one of these custom models in a prompt, either copy it using the button on the model, or type `<model-name>` in the prompt where you wish to use it.
-
-Please see the [Concepts Library](https://github.com/Sygil-Dev/sygil-webui/blob/master/docs/7.concepts-library.md) section to learn more about how to use these tools.
-
-## Textual Inversion
-
----
-
-TBD
-
-## Model Manager
-
----
-
-TBD
-
-## Settings
-
----
-
-*This section of the Web UI is still in development*
-
-This area allows you to customize how you want Streamlit to run. These changes will be saved to `configs/webui/userconfig_streamlit.yaml`. 

docs/5.concepts-library.md

@@ -0,0 +1,9 @@
+# SD Concepts Library
+
+## SD Concepts Library
+
+---
+
+![](../images/streamlit/streamlit-concepts.png)
+
+The Concept Library allows for the easy usage of custom textual inversion models. These models may be loaded into `models/custom/sd-concepts-library` and will appear in the Concepts Library in Streamlit. To use one of these custom models in a prompt, either copy it using the button on the model, or type `<model-name>` in the prompt where you wish to use it.

docs/6.custom-models.md

@@ -0,0 +1,51 @@
+# Custom Models
+
+<!--
+This file is part of sygil-webui (https://github.com/Sygil-Dev/sygil-webui/).
+
+Copyright 2022 Sygil-Dev team.
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+-->
+
+You can use other *versions* of Stable Diffusion, and *fine-tunes* of Stable Diffusion. 
+
+Any model with the `.ckpt` extension can be placed into the `models/custom` folder and used in the UI. The filename of the model will be used to show the model on the drop-down menu on the UI from which you can select and use your custom model so, make sure it has a good filename so you can recognize it from the drop-down menu.
+
+# Official models supported:
+
+## Stable Diffusion versions:
+
+- ### [Stable Diffusion v1-3](https://huggingface.co/CompVis/stable-diffusion-v1-3)
+
+- ### [Stable Diffusion v1-4](https://huggingface.co/CompVis/stable-diffusion-v1-4)
+
+- ### [Stable Diffusion v1-5](https://huggingface.co/runwayml/stable-diffusion-v1-5)
+
+## Waifu Diffusion versions:
+
+- ### Waifu Diffusion v1.2
+
+- ### [Waifu Diffusion v1.3](https://huggingface.co/hakurei/waifu-diffusion-v1-3)
+
+## Trinart:
+
+- ### [Trinart Characters](https://huggingface.co/naclbit/trinart_characters_19.2m_stable_diffusion_v1)
+
+- ### [Trinart v2](https://huggingface.co/naclbit/trinart_stable_diffusion_v2)
+
+- 
+
+## Unofficial Model List:
+
+- ### [Rentry Stable Diffusion Model List.](https://rentry.org/sdmodels)

docs/7.concepts-library.md

@@ -1,20 +0,0 @@
-<!--
-This file is part of sygil-webui (https://github.com/Sygil-Dev/sygil-webui/).
-
-Copyright 2022 Sygil-Dev team.
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
--->
-
-
-TBD

docs/8.custom-models.md

@@ -1,43 +0,0 @@
----
-title: Custom models
----
-<!--
-This file is part of sygil-webui (https://github.com/Sygil-Dev/sygil-webui/).
-
-Copyright 2022 Sygil-Dev team.
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
--->
-
-
-You can use other *versions* of Stable Diffusion, and *finetunes* of Stable Diffusion.
-
-## Stable Diffusion versions
-
-### v1-3
-
-### v1-4
-
-### 🔜™️ v1-5 🔜™️ 
-
-## Finetunes
-
-## TrinArt/Trin-sama
-
-### [v1](https://huggingface.co/naclbit/trinart_stable_diffusion)
-
-### [v2](https://huggingface.co/naclbit/trinart_stable_diffusion_v2)
-
-## [Waifu Diffusion](https://huggingface.co/hakurei/waifu-diffusion)
-
-### [v2](https://storage.googleapis.com/ws-store2/wd-v1-2-full-ema.ckpt) [trimmed](https://huggingface.co/crumb/pruned-waifu-diffusion)

docusaurus.config.js

@@ -12,7 +12,7 @@ const config = {
   baseUrl: '/sygil-webui',
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
-  favicon: 'images/logo.svg',
+  //favicon: 'images/logo.svg',
 
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.
@@ -28,14 +28,10 @@ const config = {
     locales: ['en'],
   },
   
-  // ...
-  plugins: [require.resolve("@cmfcmf/docusaurus-search-local")],
-
-  // or, if you want to specify options:
-
   // ...
   plugins: [
     [
+	  // enable search using docusaurus-search-local
       require.resolve("@cmfcmf/docusaurus-search-local"),
       {
 	  // whether to index docs pages
@@ -112,21 +108,23 @@ const config = {
       /** @type {import('@docusaurus/preset-classic').Options} */
       ({
         docs: {
-          sidebarPath: require.resolve('./sidebars.js'),
-          // Please change this to your repo.
-          // Remove this to remove the "edit this page" links.
-          editUrl:
-            'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
-        },
+			
+			sidebarCollapsed: false,
+			sidebarPath: require.resolve('./sidebars.js'),
+			// Please change this to your repo.
+			// Remove this to remove the "edit this page" links.
+			editUrl:
+				'https://github.com/Sygil-Dev/sygil-webui/tree/main/',
+		},
         blog: {
-          showReadingTime: true,
-          // Please change this to your repo.
-          // Remove this to remove the "edit this page" links.
-          editUrl:
-            'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
-        },
+			showReadingTime: true,
+			// Please change this to your repo.
+			// Remove this to remove the "edit this page" links.
+			editUrl:
+				'https://github.com/Sygil-Dev/sygil-webui/tree/main/',
+		},
         theme: {
-          customCss: require.resolve('./frontend/css/docs_custom.css'),
+			customCss: require.resolve('./frontend/css/docs_custom.css'),
         },
       }),
     ],
@@ -137,14 +135,14 @@ const config = {
     ({
       navbar: {
         title: 'Sygil WebUI',
-        logo: {
-          alt: 'Sygil Logo',
-          src: 'images/logo.svg',
-        },
+        //logo: {
+        //  alt: 'Sygil Logo',
+        //  src: 'images/logo.svg',
+        //},
         items: [
           {
             type: 'doc',
-            docId: 'windows-installation',
+            docId: 'Installation/one-click-installer',
             position: 'left',
             label: 'Getting Started',
           },

installer/readme.txt

@@ -1,11 +0,0 @@
-Sygil WebUI
-
-Project homepage: https://github.com/Sygil-Dev/sygil-webui
-
-Installation on Windows:
- Please double-click the 'install.bat' file (while keeping it inside the sygil folder).
-
-Installation on Linux:
- Please open the terminal, and run './install.sh' (while keeping it inside the sygil folder).
-
-After installation, please run the 'webui.cmd' file (on Windows) or 'webui.sh' file (on Linux/Mac) to start Sygil.

src/pages/index.js

@@ -17,7 +17,7 @@ function HomepageHeader() {
         <div className={styles.buttons}>
           <Link
             className="button button--secondary button--lg"
-            to="/docs/windows-installation">
+            to="docs/Installation/one-click-installer">
             Get Started
           </Link>
         </div>