Mirrored_Repos/InvokeAI
1
0
Fork 0
mirror of https://github.com/invoke-ai/InvokeAI synced 2024-08-30 20:32:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update mkdocs config

Browse Source
This commit is contained in:
psychedelicious 2024-02-29 23:02:27 +11:00
parent e364ce1d4e
commit ae19971f65
2 changed files with 52 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/stylesheets/extra.css
View File

@ -1,5 +0,0 @@
:root {
--md-primary-fg-color: #35A4DB;
--md-primary-fg-color--light: #35A4DB;
--md-primary-fg-color--dark: #35A4DB;
}

101
mkdocs.yml
View File

@ -15,7 +15,7 @@ edit_uri: edit/main/docs/
copyright: Copyright © 2023 InvokeAI Team copyright: Copyright © 2023 InvokeAI Team
extra_css: extra_css:
- stylesheets/extra.css - stylesheets/extra.css
# Configuration # Configuration
theme: theme:
@ -25,18 +25,7 @@ theme:
edit: material/file-document-edit-outline edit: material/file-document-edit-outline
favicon: img/favicon.ico favicon: img/favicon.ico
palette: palette:
# - media: '(prefers-color-scheme: light)' scheme: slate
# scheme: default
# primary: custom
# toggle:
# icon: material/lightbulb
# name: Switch to dark mode
- media: '(prefers-color-scheme: dark)'
scheme: slate
primary: custom
# toggle:
# icon: material/lightbulb-outline
# name: Switch to light mode
features: features:
- navigation.instant - navigation.instant
- navigation.tabs - navigation.tabs
@ -48,7 +37,6 @@ theme:
- search.suggest - search.suggest
- toc.integrate - toc.integrate
# Extensions # Extensions
markdown_extensions: markdown_extensions:
- abbr - abbr
@ -66,8 +54,8 @@ markdown_extensions:
- pymdownx.caret - pymdownx.caret
- pymdownx.details - pymdownx.details
- pymdownx.emoji: - pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight: - pymdownx.highlight:
anchor_linenums: true anchor_linenums: true
- pymdownx.inlinehilite - pymdownx.inlinehilite
@ -97,12 +85,25 @@ plugins:
enable_creation_date: true enable_creation_date: true
- redirects: - redirects:
redirect_maps: redirect_maps:
'installation/INSTALL_AUTOMATED.md': 'installation/010_INSTALL_AUTOMATED.md' 'installation/INSTALL_AUTOMATED.md': 'installation/010_INSTALL_AUTOMATED.md'
'installation/INSTALL_MANUAL.md': 'installation/020_INSTALL_MANUAL.md' 'installation/INSTALL_MANUAL.md': 'installation/020_INSTALL_MANUAL.md'
'installation/INSTALL_SOURCE.md': 'installation/020_INSTALL_MANUAL.md' 'installation/INSTALL_SOURCE.md': 'installation/020_INSTALL_MANUAL.md'
'installation/INSTALL_DOCKER.md': 'installation/040_INSTALL_DOCKER.md' 'installation/INSTALL_DOCKER.md': 'installation/040_INSTALL_DOCKER.md'
'installation/INSTALLING_MODELS.md': 'installation/050_INSTALLING_MODELS.md' 'installation/INSTALLING_MODELS.md': 'installation/050_INSTALLING_MODELS.md'
'installation/INSTALL_PATCHMATCH.md': 'installation/060_INSTALL_PATCHMATCH.md' 'installation/INSTALL_PATCHMATCH.md': 'installation/060_INSTALL_PATCHMATCH.md'
- mkdocstrings:
handlers:
python:
options:
separate_signature: true
show_signature_annotations: true
parameter_headings: false
signature_crossrefs: true
show_source: false
summary: true
show_root_heading: true
show_root_full_path: false
show_bases: false
extra_javascript: extra_javascript:
- https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
@ -115,8 +116,8 @@ extra:
property: G-2X4JR4S4FB property: G-2X4JR4S4FB
nav: nav:
- Home: 'index.md' - Home: 'index.md'
- Installation: - Installation:
- Overview: 'installation/INSTALLATION.md' - Overview: 'installation/INSTALLATION.md'
- Installing with the Automated Installer: 'installation/010_INSTALL_AUTOMATED.md' - Installing with the Automated Installer: 'installation/010_INSTALL_AUTOMATED.md'
- Installing Manually: 'installation/020_INSTALL_MANUAL.md' - Installing Manually: 'installation/020_INSTALL_MANUAL.md'
@ -127,14 +128,14 @@ nav:
- Installing xFormers: 'installation/070_INSTALL_XFORMERS.md' - Installing xFormers: 'installation/070_INSTALL_XFORMERS.md'
- Developers Documentation: 'installation/Developers_documentation/BUILDING_BINARY_INSTALLERS.md' - Developers Documentation: 'installation/Developers_documentation/BUILDING_BINARY_INSTALLERS.md'
- Deprecated Documentation: - Deprecated Documentation:
- Binary Installer: 'installation/deprecated_documentation/INSTALL_BINARY.md' - Binary Installer: 'installation/deprecated_documentation/INSTALL_BINARY.md'
- Runninng InvokeAI on Google Colab: 'installation/deprecated_documentation/INSTALL_JUPYTER.md' - Runninng InvokeAI on Google Colab: 'installation/deprecated_documentation/INSTALL_JUPYTER.md'
- Manual Installation on Linux: 'installation/deprecated_documentation/INSTALL_LINUX.md' - Manual Installation on Linux: 'installation/deprecated_documentation/INSTALL_LINUX.md'
- Manual Installation on macOS: 'installation/deprecated_documentation/INSTALL_MAC.md' - Manual Installation on macOS: 'installation/deprecated_documentation/INSTALL_MAC.md'
- Manual Installation on Windows: 'installation/deprecated_documentation/INSTALL_WINDOWS.md' - Manual Installation on Windows: 'installation/deprecated_documentation/INSTALL_WINDOWS.md'
- Installing Invoke with pip: 'installation/deprecated_documentation/INSTALL_PCP.md' - Installing Invoke with pip: 'installation/deprecated_documentation/INSTALL_PCP.md'
- Source Installer: 'installation/deprecated_documentation/INSTALL_SOURCE.md' - Source Installer: 'installation/deprecated_documentation/INSTALL_SOURCE.md'
- Workflows & Nodes: - Workflows & Nodes:
- Nodes Overview: 'nodes/overview.md' - Nodes Overview: 'nodes/overview.md'
- Workflow Editor Basics: 'nodes/NODES.md' - Workflow Editor Basics: 'nodes/NODES.md'
- List of Default Nodes: 'nodes/defaultNodes.md' - List of Default Nodes: 'nodes/defaultNodes.md'
@ -142,8 +143,10 @@ nav:
- ComfyUI to InvokeAI: 'nodes/comfyToInvoke.md' - ComfyUI to InvokeAI: 'nodes/comfyToInvoke.md'
- Facetool Node: 'nodes/detailedNodes/faceTools.md' - Facetool Node: 'nodes/detailedNodes/faceTools.md'
- Contributing Nodes: 'nodes/contributingNodes.md' - Contributing Nodes: 'nodes/contributingNodes.md'
- Community Nodes: 'nodes/communityNodes.md' - Migrating from v3 to v4: 'nodes/NODES_MIGRATION_V3_V4.md'
- Features: - Invocation API: 'nodes/INVOCATION_API.md'
- Community Nodes: 'nodes/communityNodes.md'
- Features:
- Overview: 'features/index.md' - Overview: 'features/index.md'
- New to InvokeAI?: 'help/gettingStartedWithAI.md' - New to InvokeAI?: 'help/gettingStartedWithAI.md'
- Configuration: 'features/CONFIGURATION.md' - Configuration: 'features/CONFIGURATION.md'
@ -152,35 +155,35 @@ nav:
- Controlling Logging: 'features/LOGGING.md' - Controlling Logging: 'features/LOGGING.md'
- LoRAs & LCM-LoRAs: 'features/LORAS.md' - LoRAs & LCM-LoRAs: 'features/LORAS.md'
- Model Merging: 'features/MODEL_MERGING.md' - Model Merging: 'features/MODEL_MERGING.md'
- Workflows & Nodes : 'nodes/overview' - Workflows & Nodes: 'nodes/overview'
- NSFW Checker: 'features/WATERMARK+NSFW.md' - NSFW Checker: 'features/WATERMARK+NSFW.md'
- Postprocessing: 'features/POSTPROCESS.md' - Postprocessing: 'features/POSTPROCESS.md'
- Prompting Features: 'features/PROMPTS.md' - Prompting Features: 'features/PROMPTS.md'
- Textual Inversions: - Textual Inversions:
- Textual Inversions: 'features/TEXTUAL_INVERSIONS.md' - Textual Inversions: 'features/TEXTUAL_INVERSIONS.md'
- Textual Inversion Training: 'features/TRAINING.md' - Textual Inversion Training: 'features/TRAINING.md'
- Unified Canvas: 'features/UNIFIED_CANVAS.md' - Unified Canvas: 'features/UNIFIED_CANVAS.md'
- InvokeAI Web Server: 'features/WEB.md' - InvokeAI Web Server: 'features/WEB.md'
- WebUI Hotkeys: "features/WEBUIHOTKEYS.md" - WebUI Hotkeys: 'features/WEBUIHOTKEYS.md'
- Maintenance Utilities: "features/UTILITIES.md" - Maintenance Utilities: 'features/UTILITIES.md'
- Other: 'features/OTHER.md' - Other: 'features/OTHER.md'
- Contributing: - Contributing:
- How to Contribute: 'contributing/CONTRIBUTING.md' - How to Contribute: 'contributing/CONTRIBUTING.md'
- InvokeAI Code of Conduct: 'CODE_OF_CONDUCT.md' - InvokeAI Code of Conduct: 'CODE_OF_CONDUCT.md'
- Development: - Development:
- Overview: 'contributing/contribution_guides/development.md' - Overview: 'contributing/contribution_guides/development.md'
- New Contributors: 'contributing/contribution_guides/newContributorChecklist.md' - New Contributors: 'contributing/contribution_guides/newContributorChecklist.md'
- Model Manager v2: 'contributing/MODEL_MANAGER.md' - Model Manager v2: 'contributing/MODEL_MANAGER.md'
- Frontend Documentation: 'contributing/contribution_guides/contributingToFrontend.md' - Frontend Documentation: 'contributing/contribution_guides/contributingToFrontend.md'
- Local Development: 'contributing/LOCAL_DEVELOPMENT.md' - Local Development: 'contributing/LOCAL_DEVELOPMENT.md'
- Testing: 'contributing/TESTS.md' - Testing: 'contributing/TESTS.md'
- Documentation: 'contributing/contribution_guides/documentation.md' - Documentation: 'contributing/contribution_guides/documentation.md'
- Nodes: 'contributing/INVOCATIONS.md' - Nodes: 'contributing/INVOCATIONS.md'
- Model Manager: 'contributing/MODEL_MANAGER.md' - Model Manager: 'contributing/MODEL_MANAGER.md'
- Download Queue: 'contributing/DOWNLOAD_QUEUE.md' - Download Queue: 'contributing/DOWNLOAD_QUEUE.md'
- Translation: 'contributing/contribution_guides/translation.md' - Translation: 'contributing/contribution_guides/translation.md'
- Tutorials: 'contributing/contribution_guides/tutorials.md' - Tutorials: 'contributing/contribution_guides/tutorials.md'
- Deprecated: - Deprecated:
- InvokeAI 2.3: 'deprecated/2to3.md' - InvokeAI 2.3: 'deprecated/2to3.md'
- Command Line Interface: 'deprecated/CLI.md' - Command Line Interface: 'deprecated/CLI.md'
- Changelog: 'CHANGELOG.md' - Changelog: 'CHANGELOG.md'
@ -190,11 +193,11 @@ nav:
- Inpainting: 'deprecated/INPAINTING.md' - Inpainting: 'deprecated/INPAINTING.md'
- Outpainting: 'deprecated/OUTPAINTING.md' - Outpainting: 'deprecated/OUTPAINTING.md'
- Troubleshooting: 'help/deprecated/TROUBLESHOOT.md' - Troubleshooting: 'help/deprecated/TROUBLESHOOT.md'
- Help: - Help:
- Getting Started: 'help/gettingStartedWithAI.md' - Getting Started: 'help/gettingStartedWithAI.md'
- FAQs: 'help/FAQ.md' - FAQs: 'help/FAQ.md'
- Diffusion Overview: 'help/diffusion.md' - Diffusion Overview: 'help/diffusion.md'
- Sampler Convergence: 'help/SAMPLER_CONVERGENCE.md' - Sampler Convergence: 'help/SAMPLER_CONVERGENCE.md'
- Other: - Other:
- Contributors: 'other/CONTRIBUTORS.md' - Contributors: 'other/CONTRIBUTORS.md'
- CompViz-README: 'other/README-CompViz.md' - CompViz-README: 'other/README-CompViz.md'