Mkdocs-material (invoke-ai#575)

* Squashed commit of the following:

commit 82d9c25
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 19:29:11 2022 +0200

    fix branch name in mkdocs-flow

commit 2e276ce
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 19:28:35 2022 +0200

    fix theme name

commit 2eb77c1
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 19:14:42 2022 +0200

    fixed some links and formating in main README

commit 66a7152
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 08:58:58 2022 +0200

    trigger mkdocs deployment on main

commit 897cc37
Merge: 89da371 3b5a830
Author: Matthias Wild <40327258+mauwii@users.noreply.github.com>
Date:   Wed Sep 14 07:51:23 2022 +0200

    Merge pull request invoke-ai#1 from mauwii/mkdocs

    Mkdocs

commit 3b5a830
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 0b4f5a9
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 07:41:45 2022 +0200

    update mkdocs config

commit 872172e
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 07:33:49 2022 +0200

    added the mkdocs-git-revision-date-plugin

commit eac81bf
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 b36d4cc
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 02:06:39 2022 +0200

    add dark theme

commit a14f18f
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 01:38:02 2022 +0200

    update mkdocs flow and config

commit 2764b48
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 01:15:33 2022 +0200

    add mkdocs workflow

commit 1bd2252
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>

Author: mauwii

.github/workflows/mkdocs-flow.yml

@@ -0,0 +1,23 @@
+name: Deploy
+on:
+  push:
+    branches:
+      - main
+jobs:
+  build:
+    name: Deploy docs to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Build
+        uses: Tiryoh/actions-mkdocs@v0
+        with:
+          mkdocs_version: 'latest' # option
+          requirements: '/requirements-mkdocs.txt' # option
+          configfile: '/mkdocs.yml' # option
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site

.prettierrc.yaml

@@ -0,0 +1,13 @@
+endOfLine: lf
+tabWidth: 2
+useTabs: false
+singleQuote: true
+quoteProps: as-needed
+embeddedLanguageFormatting: auto
+overrides:
+  - files: "*.md"
+    options:
+      proseWrap: always
+      printWidth: 100
+      parser: markdown
+      cursorOffset: -1

README.md

@@ -1,7 +1,7 @@
 <h1 align='center'><b>Stable Diffusion Dream Script</b></h1>
 
 <p align='center'>
-<img src="docs/assets/logo.png"/>
+    <img src="docs/assets/logo.png"/>
 </p>
 
 <p align="center">
@@ -12,37 +12,39 @@
     <img src="https://img.shields.io/github/issues-pr/lstein/stable-diffusion?logo=GitHub&style=for-the-badge" alt="pull-requests"/>
 </p>
 
-# **Stable Diffusion Dream Script**
-
-This is a fork of
-[CompVis/stable-diffusion](https://github.com/CompVis/stable-diffusion),
-the open source text-to-image generator. It provides a streamlined
-process with various new features and options to aid the image
-generation process. It runs on Windows, Mac and Linux machines,
-and runs on GPU cards with as little as 4 GB or RAM.
+This is a fork of [CompVis/stable-diffusion](https://github.com/CompVis/stable-diffusion), the open
+source text-to-image generator. It provides a streamlined process with various new features and
+options to aid the image generation process. It runs on Windows, Mac and Linux machines, and runs on
+GPU cards with as little as 4 GB or RAM.
 
 _Note: This fork is rapidly evolving. Please use the
-[Issues](https://github.com/lstein/stable-diffusion/issues) tab to
-report bugs and make feature requests. Be sure to use the provided
-templates. They will help aid diagnose issues faster._
+[Issues](https://github.com/lstein/stable-diffusion/issues) tab to report bugs and make feature
+requests. Be sure to use the provided templates. They will help aid diagnose issues faster._
+
+**Table of Contents**
 
-# **Table of Contents**
 1. [Installation](#installation)
-2. [Major Features](#features)
-3. [Changelog](#latest-changes)
-4. [Troubleshooting](#troubleshooting)
-5. [Contributing](#contributing)
-6. [Support](#support)
+2. [Hardware Requirements](#hardware-requirements)
+3. [Features](#features)
+4. [Latest Changes](#latest-changes)
+5. [Troubleshooting](#troubleshooting)
+6. [Contributing](#contributing)
+7. [Contributors](#contributors)
+8. [Support](#support)
+9. [Further Reading](#further-reading)
+
+## Installation
 
-# Installation
+This fork is supported across multiple platforms. You can find individual installation instructions
+below.
 
-This fork is supported across multiple platforms. You can find individual installation instructions below.
+- ### [Linux](docs/installation/INSTALL_LINUX.md)
 
-- ## [Linux](docs/installation/INSTALL_LINUX.md)
-- ## [Windows](docs/installation/INSTALL_WINDOWS.md)
-- ## [Macintosh](docs/installation/INSTALL_MAC.md)
+- ### [Windows](docs/installation/INSTALL_WINDOWS.md)
 
-## **Hardware Requirements**
+- ### [Macintosh](docs/installation/INSTALL_MAC.md)
+
+## Hardware Requirements
 
 **System**
 
@@ -61,109 +63,117 @@ You wil need one of the following:
 
 **Note**
 
-If you are have a Nvidia 10xx series card (e.g. the 1080ti), please
-run the dream script in full-precision mode as shown below.
+If you are have a Nvidia 10xx series card (e.g. the 1080ti), please run the dream script in
+full-precision mode as shown below.
 
 Similarly, specify full-precision mode on Apple M1 hardware.
 
-To run in full-precision mode, start `dream.py` with the
-`--full_precision` flag:
+To run in full-precision mode, start `dream.py` with the `--full_precision` flag:
 
-```
+```bash
 (ldm) ~/stable-diffusion$ python scripts/dream.py --full_precision
 ```
 
-# Features
-
-## **Major Features**
+## Features
 
-- ## [Interactive Command Line Interface](docs/features/CLI.md)
+### Major Features
 
-- ## [Image To Image](docs/features/IMG2IMG.md)
+- #### [Interactive Command Line Interface](docs/features/CLI.md)
 
-- ## [Inpainting Support](docs/features/INPAINTING.md)
+- #### [Image To Image](docs/features/IMG2IMG.md)
 
-- ## [GFPGAN and Real-ESRGAN Support](docs/features/UPSCALE.md)
+- #### [Inpainting Support](docs/features/INPAINTING.md)
 
-- ## [Embiggen upscaling](docs/features/EMBIGGEN.md)
+- #### [GFPGAN and Real-ESRGAN Support](docs/features/UPSCALE.md)
 
-- ## [Seamless Tiling](docs/features/OTHER.md#seamless-tiling)
+- #### [Seamless Tiling](docs/features/OTHER.md#seamless-tiling)
 
-- ## [Google Colab](docs/features/OTHER.md#google-colab)
+- #### [Google Colab](docs/features/OTHER.md#google-colab)
 
-- ## [Web Server](docs/features/WEB.md)
+- #### [Web Server](docs/features/WEB.md)
 
-- ## [Reading Prompts From File](docs/features/OTHER.md#reading-prompts-from-a-file)
+- #### [Reading Prompts From File](docs/features/OTHER.md#reading-prompts-from-a-file)
 
-- ## [Shortcut: Reusing Seeds](docs/features/OTHER.md#shortcuts-reusing-seeds)
+- #### [Shortcut: Reusing Seeds](docs/features/OTHER.md#shortcuts-reusing-seeds)
 
-- ## [Weighted Prompts](docs/features/OTHER.md#weighted-prompts)
+- #### [Weighted Prompts](docs/features/OTHER.md#weighted-prompts)
 
-- ## [Variations](docs/features/VARIATIONS.md)
+- #### [Variations](docs/features/VARIATIONS.md)
 
-- ## [Personalizing Text-to-Image Generation](docs/features/TEXTUAL_INVERSION.md)
+- #### [Personalizing Text-to-Image Generation](docs/features/TEXTUAL_INVERSION.md)
 
-- ## [Simplified API for text to image generation](docs/features/OTHER.md#simplified-api)
+- #### [Simplified API for text to image generation](docs/features/OTHER.md#simplified-api)
 
-## **Other Features**
+### Other Features
 
-- ### [Creating Transparent Regions for Inpainting](docs/features/INPAINTING.md#creating-transparent-regions-for-inpainting)
+- #### [Creating Transparent Regions for Inpainting](docs/features/INPAINTING.md#creating-transparent-regions-for-inpainting)
 
-- ### [Preload Models](docs/features/OTHER.md#preload-models)
+- #### [Preload Models](docs/features/OTHER.md#preload-models)
 
-# Latest Changes
+## Latest Changes
 
 - v1.14 (11 September 2022)
 
   - Memory optimizations for small-RAM cards. 512x512 now possible on 4 GB GPUs.
   - Full support for Apple hardware with M1 or M2 chips.
-  - Add "seamless mode" for circular tiling of image. Generates beautiful effects. ([prixt](https://github.com/prixt)).
+  - Add "seamless mode" for circular tiling of image. Generates beautiful effects.
+    ([prixt](https://github.com/prixt)).
   - Inpainting support.
   - Improved web server GUI.
   - Lots of code and documentation cleanups.
 
 - v1.13 (3 September 2022
 
-  - Support image variations (see [VARIATIONS](docs/features/VARIATIONS.md) ([Kevin Gibbons](https://github.com/bakkot) and many contributors and reviewers)
-  - Supports a Google Colab notebook for a standalone server running on Google hardware [Arturo Mendivil](https://github.com/artmen1516)
-  - WebUI supports GFPGAN/ESRGAN facial reconstruction and upscaling [Kevin Gibbons](https://github.com/bakkot)
-  - WebUI supports incremental display of in-progress images during generation [Kevin Gibbons](https://github.com/bakkot)
-  - A new configuration file scheme that allows new models (including upcoming stable-diffusion-v1.5)
-    to be added without altering the code. ([David Wager](https://github.com/maddavid12))
+  - Support image variations (see [VARIATIONS](docs/features/VARIATIONS.md)
+    ([Kevin Gibbons](https://github.com/bakkot) and many contributors and reviewers)
+  - Supports a Google Colab notebook for a standalone server running on Google hardware
+    [Arturo Mendivil](https://github.com/artmen1516)
+  - WebUI supports GFPGAN/ESRGAN facial reconstruction and upscaling
+    [Kevin Gibbons](https://github.com/bakkot)
+  - WebUI supports incremental display of in-progress images during generation
+    [Kevin Gibbons](https://github.com/bakkot)
+  - A new configuration file scheme that allows new models (including upcoming
+    stable-diffusion-v1.5) to be added without altering the code.
+    ([David Wager](https://github.com/maddavid12))
   - Can specify --grid on dream.py command line as the default.
   - Miscellaneous internal bug and stability fixes.
   - Works on M1 Apple hardware.
   - Multiple bug fixes.
 
-For older changelogs, please visit **[CHANGELOGS](docs/CHANGELOG.md)**. 
+For older changelogs, please visit the **[CHANGELOG](docs/features/CHANGELOG.md)**.
 
-# Troubleshooting
+## Troubleshooting
 
-Please check out our **[Q&A](docs/help/TROUBLESHOOT.md)** to get solutions for common installation problems and other issues.
+Please check out our **[Q&A](docs/help/TROUBLESHOOT.md)** to get solutions for common installation
+problems and other issues.
 
-# Contributing
+## Contributing
 
-Anyone who wishes to contribute to this project, whether documentation, features, bug fixes, code cleanup, testing, or code reviews, is very much encouraged to do so. If you are unfamiliar with
-how to contribute to GitHub projects, here is a [Getting Started Guide](https://opensource.com/article/19/7/create-pull-request-github).
+Anyone who wishes to contribute to this project, whether documentation, features, bug fixes, code
+cleanup, testing, or code reviews, is very much encouraged to do so. If you are unfamiliar with how
+to contribute to GitHub projects, here is a
+[Getting Started Guide](https://opensource.com/article/19/7/create-pull-request-github).
 
-A full set of contribution guidelines, along with templates, are in progress, but for now the most important thing is to **make your pull request against the "development" branch**, and not against "main". This will help keep public breakage to a minimum and will allow you to propose more radical changes.
+A full set of contribution guidelines, along with templates, are in progress, but for now the most
+important thing is to **make your pull request against the "development" branch**, and not against
+"main". This will help keep public breakage to a minimum and will allow you to propose more radical
+changes.
 
-## **Contributors**
+## Contributors
 
-This fork is a combined effort of various people from across the
-world. [Check out the list of all these amazing
-people](docs/CONTRIBUTORS.md). We thank them for their time, hard work
-and effort.
+This fork is a combined effort of various people from across the world.
+[Check out the list of all these amazing people](docs/other/CONTRIBUTORS.md). We thank them for
+their time, hard work and effort.
 
-# Support
+## Support
 
-For support,
-please use this repository's GitHub Issues tracking service. Feel free
-to send me an email if you use and like the script.
+For support, please use this repository's GitHub Issues tracking service. Feel free to send me an
+email if you use and like the script.
 
-Original portions of the software are Copyright (c) 2020 Lincoln D. Stein (https://github.com/lstein)
+Original portions of the software are Copyright (c) 2020
+[Lincoln D. Stein](https://github.com/lstein)
 
-# Further Reading
+## Further Reading
 
-Please see the original README for more information on this software
-and underlying algorithm, located in the file [README-CompViz.md](docs/README-CompViz.md).
+Please see the original README for more information on this software and underlying algorithm,
+located in the file [README-CompViz.md](docs/other/README-CompViz.md).