dnrops
/
komorebi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
komorebi/mkdocs.yml

226 lines
7.1 KiB
YAML
Raw Permalink Normal View History

docs(mkdocs): start building dedicated site
2024-01-13 10:40:58 +08:00
copyright: Copyright © 2020-Present LGUG2Z
use_directory_urls: false
site_name: Komorebi
site_description: The Tiling Window Manager for Windows
repo_url: https://github.com/LGUG2Z/komorebi
repo_name: LGUG2Z/komorebi
docs_dir: docs
theme:
name: material
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: deep purple
accent: deep purple
toggle:
icon: material/weather-sunny
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep purple
accent: purple
toggle:
icon: material/weather-night
name: Switch to light mode
features:
- content.action.edit
- content.action.view
- content.code.copy
- content.tabs.link
- navigation.footer
- navigation.indexes
docs(mkdocs): add index and getting started sections
2024-01-14 13:52:27 +08:00
- navigation.sections
docs(mkdocs): start building dedicated site
2024-01-13 10:40:58 +08:00
- navigation.tabs
- navigation.top
docs(mkdocs): add index and getting started sections
2024-01-14 13:52:27 +08:00
- navigation.tracking
docs(mkdocs): start building dedicated site
2024-01-13 10:40:58 +08:00
- search.highlight
- search.share
- search.suggest
- toc.follow
docs(mkdocs): add admonition extension Used for bringing attention to troubleshooting steps in komorebi documentation. Reference: https://squidfunk.github.io/mkdocs-material/reference/admonitions/
2024-05-07 01:50:04 +08:00
markdown_extensions:
- admonition
docs(mkdocs): add pymdownx.highlight and pymdownx.superfences extensions Used for syntax highlighting in code blocks, and allows for indenting existing code blocks. References: - https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight - https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences
2024-05-07 01:50:44 +08:00
- pymdownx.highlight
- pymdownx.superfences
docs(mkdocs): add index and getting started sections
2024-01-14 13:52:27 +08:00
plugins:
- macros
docs(mkdocs): add cli reference
2024-01-15 09:43:24 +08:00
- search
docs(mkdocs): add index and getting started sections
2024-01-14 13:52:27 +08:00
nav:
- Komorebi:
docs(mkdocs): various updates to reflect v0.1.25-dev.0
2024-04-29 04:51:08 +08:00
- index.md
- Design: design.md
docs(mkdocs): add index and getting started sections
2024-01-14 13:52:27 +08:00
- Getting started:
docs(mkdocs): various updates to reflect v0.1.25-dev.0
2024-04-29 04:51:08 +08:00
- Installation: installation.md
- Example configurations: example-configurations.md
docs(mkdocs): addressing display suspension within monitor OSD
2024-05-07 01:51:45 +08:00
- Troubleshooting: troubleshooting.md
docs(mkdocs): add common workflows section
2024-02-12 09:45:12 +08:00
- Common workflows:
docs(mkdocs): various updates to reflect v0.1.25-dev.0
2024-04-29 04:51:08 +08:00
- common-workflows/komorebi-config-home.md
docs(mkdocs): add updates for v0.1.28 features
2024-07-14 05:40:43 +08:00
- common-workflows/animations.md
chore(dev): begin v0.1.27-dev
2024-05-24 07:47:26 +08:00
- common-workflows/autohotkey.md
docs(wm): border renames and aliases, ahk example This commit renames a number of border-related code refs, removing the ActiveWindow prefix since these borders are no longer just for the active window. Aliases have been added to preserve backwards compat for existing configs. An example AHK configuration file has been added to the Common Workflows section of the docs site. A link to the docs site has been added to the output of komorebic start. A note has been added recommending that users disable system animations for the best experience in the Getting Started guide.
2024-05-16 02:39:32 +08:00
- common-workflows/borders.md
docs(mkdocs): various updates to reflect v0.1.25-dev.0
2024-04-29 04:51:08 +08:00
- common-workflows/stackbar.md
- common-workflows/remove-gaps.md
- common-workflows/ignore-windows.md
- common-workflows/force-manage-windows.md
- common-workflows/tray-and-multi-window-applications.md
- common-workflows/focus-follows-mouse.md
- common-workflows/mouse-follows-focus.md
- common-workflows/custom-layouts.md
- common-workflows/dynamic-layout-switching.md
docs(mkdocs) add display index preferences section
2024-06-02 04:25:15 +08:00
- common-workflows/set-display-index.md
docs(mkdocs): updates for v0.1.22
2024-02-26 05:18:11 +08:00
- Release notes:
docs(mkdocs): various updates to reflect v0.1.25-dev.0
2024-04-29 04:51:08 +08:00
- release/v0-1-22.md
docs(mkdocs): add common workflows section
2024-02-12 09:45:12 +08:00
- Configuration reference: https://komorebi.lgug2z.com/schema
docs(mkdocs): add cli reference
2024-01-15 09:43:24 +08:00
- CLI reference:
docs(mkdocs): various updates to reflect v0.1.25-dev.0
2024-04-29 04:51:08 +08:00
- cli/quickstart.md
- cli/start.md
- cli/stop.md
- cli/check.md
- cli/configuration.md
- cli/whkdrc.md
- cli/state.md
- cli/global-state.md
docs(wm): add komorebi-gui binary, update mkdocs
2024-05-20 07:15:18 +08:00
- cli/gui.md
docs(mkdocs): various updates to reflect v0.1.25-dev.0
2024-04-29 04:51:08 +08:00
- cli/visible-windows.md
chore(release): v0.1.27
2024-06-20 05:52:54 +08:00
- cli/monitor-information.md
docs(mkdocs): various updates to reflect v0.1.25-dev.0
2024-04-29 04:51:08 +08:00
- cli/query.md
- cli/subscribe-socket.md
- cli/unsubscribe-socket.md
- cli/subscribe-pipe.md
- cli/unsubscribe-pipe.md
- cli/log.md
- cli/quick-save-resize.md
- cli/quick-load-resize.md
- cli/save-resize.md
- cli/load-resize.md
- cli/focus.md
- cli/move.md
- cli/minimize.md
- cli/close.md
- cli/force-focus.md
- cli/cycle-focus.md
- cli/cycle-move.md
- cli/stack.md
chore(release): v0.1.27
2024-06-20 05:52:54 +08:00
- cli/stack-all.md
- cli/unstack-all.md
docs(mkdocs): various updates to reflect v0.1.25-dev.0
2024-04-29 04:51:08 +08:00
- cli/resize-edge.md
- cli/resize-axis.md
- cli/unstack.md
- cli/cycle-stack.md
- cli/move-to-monitor.md
- cli/cycle-move-to-monitor.md
- cli/move-to-workspace.md
- cli/move-to-named-workspace.md
- cli/cycle-move-to-workspace.md
- cli/send-to-monitor.md
- cli/cycle-send-to-monitor.md
- cli/send-to-workspace.md
- cli/send-to-named-workspace.md
- cli/cycle-send-to-workspace.md
- cli/send-to-monitor-workspace.md
- cli/move-to-monitor-workspace.md
- cli/focus-monitor.md
- cli/focus-last-workspace.md
- cli/focus-workspace.md
- cli/focus-workspaces.md
- cli/focus-monitor-workspace.md
- cli/focus-named-workspace.md
- cli/cycle-monitor.md
- cli/cycle-workspace.md
- cli/move-workspace-to-monitor.md
docs(wm): add komorebi-gui binary, update mkdocs
2024-05-20 07:15:18 +08:00
- cli/cycle-move-workspace-to-monitor.md
docs(mkdocs): various updates to reflect v0.1.25-dev.0
2024-04-29 04:51:08 +08:00
- cli/swap-workspaces-with-monitor.md
- cli/new-workspace.md
- cli/resize-delta.md
- cli/invisible-borders.md
- cli/global-work-area-offset.md
- cli/monitor-work-area-offset.md
- cli/focused-workspace-container-padding.md
- cli/focused-workspace-padding.md
- cli/adjust-container-padding.md
- cli/adjust-workspace-padding.md
- cli/change-layout.md
- cli/cycle-layout.md
- cli/load-custom-layout.md
- cli/flip-layout.md
- cli/promote.md
- cli/promote-focus.md
docs(wm): add komorebi-gui binary, update mkdocs
2024-05-20 07:15:18 +08:00
- cli/promote-window.md
docs(mkdocs): various updates to reflect v0.1.25-dev.0
2024-04-29 04:51:08 +08:00
- cli/retile.md
- cli/monitor-index-preference.md
- cli/display-index-preference.md
- cli/ensure-workspaces.md
- cli/ensure-named-workspaces.md
- cli/container-padding.md
- cli/named-workspace-container-padding.md
- cli/workspace-padding.md
- cli/named-workspace-padding.md
- cli/workspace-layout.md
- cli/named-workspace-layout.md
- cli/workspace-custom-layout.md
- cli/named-workspace-custom-layout.md
- cli/workspace-layout-rule.md
- cli/named-workspace-layout-rule.md
- cli/workspace-custom-layout-rule.md
- cli/named-workspace-custom-layout-rule.md
- cli/clear-workspace-layout-rules.md
- cli/clear-named-workspace-layout-rules.md
- cli/workspace-tiling.md
- cli/named-workspace-tiling.md
- cli/workspace-name.md
- cli/toggle-window-container-behaviour.md
- cli/toggle-pause.md
- cli/toggle-tiling.md
- cli/toggle-float.md
- cli/toggle-monocle.md
- cli/toggle-maximize.md
- cli/restore-windows.md
- cli/manage.md
- cli/unmanage.md
- cli/reload-configuration.md
- cli/watch-configuration.md
- cli/complete-configuration.md
- cli/window-hiding-behaviour.md
- cli/cross-monitor-move-behaviour.md
- cli/toggle-cross-monitor-move-behaviour.md
- cli/unmanaged-window-operation-behaviour.md
- cli/float-rule.md
- cli/manage-rule.md
- cli/initial-workspace-rule.md
- cli/initial-named-workspace-rule.md
- cli/workspace-rule.md
- cli/named-workspace-rule.md
docs(mkdocs): add updates for v0.1.28 features
2024-07-14 05:40:43 +08:00
- cli/clear-workspace-rules.md
- cli/clear-named-workspace-rules.md
- cli/clear-all-workspace-rules.md
docs(mkdocs): various updates to reflect v0.1.25-dev.0
2024-04-29 04:51:08 +08:00
- cli/identify-object-name-change-application.md
- cli/identify-tray-application.md
- cli/identify-layered-application.md
- cli/remove-title-bar.md
- cli/toggle-title-bars.md
docs(wm): border renames and aliases, ahk example This commit renames a number of border-related code refs, removing the ActiveWindow prefix since these borders are no longer just for the active window. Aliases have been added to preserve backwards compat for existing configs. An example AHK configuration file has been added to the Common Workflows section of the docs site. A link to the docs site has been added to the output of komorebic start. A note has been added recommending that users disable system animations for the best experience in the Getting Started guide.
2024-05-16 02:39:32 +08:00
- cli/border.md
- cli/border-colour.md
- cli/border-width.md
- cli/border-offset.md
docs(mkdocs): add updates for v0.1.28 features
2024-07-14 05:40:43 +08:00
- cli/border-style.md
- cli/border-implementation.md
chore(release): v0.1.27
2024-06-20 05:52:54 +08:00
- cli/transparency.md
- cli/transparency-alpha.md
docs(mkdocs): various updates to reflect v0.1.25-dev.0
2024-04-29 04:51:08 +08:00
- cli/focus-follows-mouse.md
- cli/toggle-focus-follows-mouse.md
- cli/mouse-follows-focus.md
- cli/toggle-mouse-follows-focus.md
- cli/ahk-app-specific-configuration.md
- cli/pwsh-app-specific-configuration.md
- cli/format-app-specific-configuration.md
- cli/fetch-app-specific-configuration.md
- cli/application-specific-configuration-schema.md
- cli/notification-schema.md
- cli/socket-schema.md
- cli/static-config-schema.md
- cli/generate-static-config.md
- cli/enable-autostart.md
- cli/disable-autostart.md