winutil/.github/mkdocs.yml

92 lines
2.0 KiB
YAML
Raw Normal View History

[Docs 02] Auto dev-docs & more (#2481) * Compile Winutil * pre-Releases (#1) * Create pre-release.yaml * Update release.yaml * Update pre-release.yaml * Create release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update release-drafter.yml * Update pre-release.yaml * Update release-drafter.yml * Update pre-release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Update pre-release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Compile Winutil * fixed end task with right click * Compile Winutil * code generator & compile integration * Compile Winutil * finish - add autogenerated table of content page named "Dev Docs", with table of content to all .md files - added invokescript & undoscript - generate documentation files * oops, remove dublicates * undo winutil.ps1 * remove prefixes WPF WinUtil Toggle $category Features Tweaks Panel Fixes * fixes - fix inconsistency in Featurenaming - add "Enable" & "Disable" as prefix to remove * fix spellin mistake * remove unneccesary whitespaces update info remove unnecessary whitespaces by only adding stuff to the md if it actually exists * rewrite prefix removal into one line definition * added taskscheduler support * add support for function calling add support for functioncalling - replace code formatting for invoke & undo script from json to powershell * content instead of displayname * add last modified date * contributing + docs generator - moved contribute.md to root CONTRIBUTING.md - referenced CONTRIBUTING.md in contribute.md - added toggle & button reference to functions - added function references in functions - changed mkdocs site styling * Use HashSet for processedFunctions Use HashSet for processedFunctions: - Ensures dynamic addition of functions without duplication. Recursive Function Scanning: - Includes all nested functions called by InvokeScript, UndoScript, ToggleScript, and ButtonScript. * follow github standards - add code of conduct - reference code of conduct in docs - regrouped docs navigation - add comment about the sourced md file * small fixes * change color from teal to blue in light mode * add links to tweaks * add archiving feature to autodocs * administrative - add script to releases and remove from compile - move link from after description to after category * small fixes - add S in feature.json - fix dating - move link to after category * fix links * undo link bc of bugs * add progress bar to script - add progress like in compile - moved archive folder creation to the beginning of the script * Simple improvements to 'auto-devdocs' branch (#3) * Fix links for tweaks & features * Make New Line characters work for Json Snippet * Change NewLine Character from Unix Style (LF) to Windows/DOS Style (CRLF) * rerun script * und workflows & rearrange navigation items * layer out itemname cutout * rework links & temp removal of archivation * fix adding link in json root not adding link member to root in json files * fix json generation replace '\r\n',"`r`n" with ('\n',"`n") * add features to auto md docs * add minify plugin * regex hotfix * refractor * add changelog to about section add link to changelog in docs for about section * undo changelog * Cleanup 'devdocs-generator.ps1' - Implement Zig Multiline String Feature (#4) * Cleanup 'devdocs-generator.ps1' - Implement Zig Multiline String Feature * Fix NewLine character replace in 'devdocs-generator.ps1' * run script * run script * Fix 'itemnametocut' RegEx in 'devdocs-generator.ps1' (#5) * rerun script * rework nav + remove code of conduct * undo workflow changes * run script * remove changelog --------- Co-authored-by: MyDrift-user <MyDrift-user@users.noreply.github.com> Co-authored-by: Mr.k <mineshtine28546271@gmail.com>
2024-08-07 15:55:23 +00:00
site_name: WinUtil Documentation
2024-08-14 15:58:33 +00:00
docs_dir: '../docs'
repo_url: https://github.com/ChrisTitusTech/winutil
nav:
- Introduction: 'index.md'
- User Guide: 'userguide.md'
2024-11-07 00:36:26 +00:00
- Contributing Guide: 'CONTRIBUTING.md'
[Docs 02] Auto dev-docs & more (#2481) * Compile Winutil * pre-Releases (#1) * Create pre-release.yaml * Update release.yaml * Update pre-release.yaml * Create release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update release-drafter.yml * Update pre-release.yaml * Update release-drafter.yml * Update pre-release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Update pre-release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Compile Winutil * fixed end task with right click * Compile Winutil * code generator & compile integration * Compile Winutil * finish - add autogenerated table of content page named "Dev Docs", with table of content to all .md files - added invokescript & undoscript - generate documentation files * oops, remove dublicates * undo winutil.ps1 * remove prefixes WPF WinUtil Toggle $category Features Tweaks Panel Fixes * fixes - fix inconsistency in Featurenaming - add "Enable" & "Disable" as prefix to remove * fix spellin mistake * remove unneccesary whitespaces update info remove unnecessary whitespaces by only adding stuff to the md if it actually exists * rewrite prefix removal into one line definition * added taskscheduler support * add support for function calling add support for functioncalling - replace code formatting for invoke & undo script from json to powershell * content instead of displayname * add last modified date * contributing + docs generator - moved contribute.md to root CONTRIBUTING.md - referenced CONTRIBUTING.md in contribute.md - added toggle & button reference to functions - added function references in functions - changed mkdocs site styling * Use HashSet for processedFunctions Use HashSet for processedFunctions: - Ensures dynamic addition of functions without duplication. Recursive Function Scanning: - Includes all nested functions called by InvokeScript, UndoScript, ToggleScript, and ButtonScript. * follow github standards - add code of conduct - reference code of conduct in docs - regrouped docs navigation - add comment about the sourced md file * small fixes * change color from teal to blue in light mode * add links to tweaks * add archiving feature to autodocs * administrative - add script to releases and remove from compile - move link from after description to after category * small fixes - add S in feature.json - fix dating - move link to after category * fix links * undo link bc of bugs * add progress bar to script - add progress like in compile - moved archive folder creation to the beginning of the script * Simple improvements to 'auto-devdocs' branch (#3) * Fix links for tweaks & features * Make New Line characters work for Json Snippet * Change NewLine Character from Unix Style (LF) to Windows/DOS Style (CRLF) * rerun script * und workflows & rearrange navigation items * layer out itemname cutout * rework links & temp removal of archivation * fix adding link in json root not adding link member to root in json files * fix json generation replace '\r\n',"`r`n" with ('\n',"`n") * add features to auto md docs * add minify plugin * regex hotfix * refractor * add changelog to about section add link to changelog in docs for about section * undo changelog * Cleanup 'devdocs-generator.ps1' - Implement Zig Multiline String Feature (#4) * Cleanup 'devdocs-generator.ps1' - Implement Zig Multiline String Feature * Fix NewLine character replace in 'devdocs-generator.ps1' * run script * run script * Fix 'itemnametocut' RegEx in 'devdocs-generator.ps1' (#5) * rerun script * rework nav + remove code of conduct * undo workflow changes * run script * remove changelog --------- Co-authored-by: MyDrift-user <MyDrift-user@users.noreply.github.com> Co-authored-by: Mr.k <mineshtine28546271@gmail.com>
2024-08-07 15:55:23 +00:00
- Documentation:
- Dev Docs: 'devdocs.md'
- Known Issues: 'KnownIssues.md'
- FAQ: 'faq.md'
not_in_nav: |
dev/
theme:
name: material
2024-08-14 15:34:19 +00:00
custom_dir: '../overrides'
features:
- navigation.tabs
- navigation.sections
- toc.integrate
- navigation.top
- search.suggest
- search.highlight
- content.tabs.link
- content.code.annotation
- content.code.copy
language: en
logo: assets/favicon.png
favicon: assets/favicon.png
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
2024-08-06 20:50:36 +00:00
scheme: default
[Docs 02] Auto dev-docs & more (#2481) * Compile Winutil * pre-Releases (#1) * Create pre-release.yaml * Update release.yaml * Update pre-release.yaml * Create release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update release-drafter.yml * Update pre-release.yaml * Update release-drafter.yml * Update pre-release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Update pre-release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Compile Winutil * fixed end task with right click * Compile Winutil * code generator & compile integration * Compile Winutil * finish - add autogenerated table of content page named "Dev Docs", with table of content to all .md files - added invokescript & undoscript - generate documentation files * oops, remove dublicates * undo winutil.ps1 * remove prefixes WPF WinUtil Toggle $category Features Tweaks Panel Fixes * fixes - fix inconsistency in Featurenaming - add "Enable" & "Disable" as prefix to remove * fix spellin mistake * remove unneccesary whitespaces update info remove unnecessary whitespaces by only adding stuff to the md if it actually exists * rewrite prefix removal into one line definition * added taskscheduler support * add support for function calling add support for functioncalling - replace code formatting for invoke & undo script from json to powershell * content instead of displayname * add last modified date * contributing + docs generator - moved contribute.md to root CONTRIBUTING.md - referenced CONTRIBUTING.md in contribute.md - added toggle & button reference to functions - added function references in functions - changed mkdocs site styling * Use HashSet for processedFunctions Use HashSet for processedFunctions: - Ensures dynamic addition of functions without duplication. Recursive Function Scanning: - Includes all nested functions called by InvokeScript, UndoScript, ToggleScript, and ButtonScript. * follow github standards - add code of conduct - reference code of conduct in docs - regrouped docs navigation - add comment about the sourced md file * small fixes * change color from teal to blue in light mode * add links to tweaks * add archiving feature to autodocs * administrative - add script to releases and remove from compile - move link from after description to after category * small fixes - add S in feature.json - fix dating - move link to after category * fix links * undo link bc of bugs * add progress bar to script - add progress like in compile - moved archive folder creation to the beginning of the script * Simple improvements to 'auto-devdocs' branch (#3) * Fix links for tweaks & features * Make New Line characters work for Json Snippet * Change NewLine Character from Unix Style (LF) to Windows/DOS Style (CRLF) * rerun script * und workflows & rearrange navigation items * layer out itemname cutout * rework links & temp removal of archivation * fix adding link in json root not adding link member to root in json files * fix json generation replace '\r\n',"`r`n" with ('\n',"`n") * add features to auto md docs * add minify plugin * regex hotfix * refractor * add changelog to about section add link to changelog in docs for about section * undo changelog * Cleanup 'devdocs-generator.ps1' - Implement Zig Multiline String Feature (#4) * Cleanup 'devdocs-generator.ps1' - Implement Zig Multiline String Feature * Fix NewLine character replace in 'devdocs-generator.ps1' * run script * run script * Fix 'itemnametocut' RegEx in 'devdocs-generator.ps1' (#5) * rerun script * rework nav + remove code of conduct * undo workflow changes * run script * remove changelog --------- Co-authored-by: MyDrift-user <MyDrift-user@users.noreply.github.com> Co-authored-by: Mr.k <mineshtine28546271@gmail.com>
2024-08-07 15:55:23 +00:00
accent: blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
[Docs 02] Auto dev-docs & more (#2481) * Compile Winutil * pre-Releases (#1) * Create pre-release.yaml * Update release.yaml * Update pre-release.yaml * Create release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update release-drafter.yml * Update pre-release.yaml * Update release-drafter.yml * Update pre-release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Update pre-release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Compile Winutil * fixed end task with right click * Compile Winutil * code generator & compile integration * Compile Winutil * finish - add autogenerated table of content page named "Dev Docs", with table of content to all .md files - added invokescript & undoscript - generate documentation files * oops, remove dublicates * undo winutil.ps1 * remove prefixes WPF WinUtil Toggle $category Features Tweaks Panel Fixes * fixes - fix inconsistency in Featurenaming - add "Enable" & "Disable" as prefix to remove * fix spellin mistake * remove unneccesary whitespaces update info remove unnecessary whitespaces by only adding stuff to the md if it actually exists * rewrite prefix removal into one line definition * added taskscheduler support * add support for function calling add support for functioncalling - replace code formatting for invoke & undo script from json to powershell * content instead of displayname * add last modified date * contributing + docs generator - moved contribute.md to root CONTRIBUTING.md - referenced CONTRIBUTING.md in contribute.md - added toggle & button reference to functions - added function references in functions - changed mkdocs site styling * Use HashSet for processedFunctions Use HashSet for processedFunctions: - Ensures dynamic addition of functions without duplication. Recursive Function Scanning: - Includes all nested functions called by InvokeScript, UndoScript, ToggleScript, and ButtonScript. * follow github standards - add code of conduct - reference code of conduct in docs - regrouped docs navigation - add comment about the sourced md file * small fixes * change color from teal to blue in light mode * add links to tweaks * add archiving feature to autodocs * administrative - add script to releases and remove from compile - move link from after description to after category * small fixes - add S in feature.json - fix dating - move link to after category * fix links * undo link bc of bugs * add progress bar to script - add progress like in compile - moved archive folder creation to the beginning of the script * Simple improvements to 'auto-devdocs' branch (#3) * Fix links for tweaks & features * Make New Line characters work for Json Snippet * Change NewLine Character from Unix Style (LF) to Windows/DOS Style (CRLF) * rerun script * und workflows & rearrange navigation items * layer out itemname cutout * rework links & temp removal of archivation * fix adding link in json root not adding link member to root in json files * fix json generation replace '\r\n',"`r`n" with ('\n',"`n") * add features to auto md docs * add minify plugin * regex hotfix * refractor * add changelog to about section add link to changelog in docs for about section * undo changelog * Cleanup 'devdocs-generator.ps1' - Implement Zig Multiline String Feature (#4) * Cleanup 'devdocs-generator.ps1' - Implement Zig Multiline String Feature * Fix NewLine character replace in 'devdocs-generator.ps1' * run script * run script * Fix 'itemnametocut' RegEx in 'devdocs-generator.ps1' (#5) * rerun script * rework nav + remove code of conduct * undo workflow changes * run script * remove changelog --------- Co-authored-by: MyDrift-user <MyDrift-user@users.noreply.github.com> Co-authored-by: Mr.k <mineshtine28546271@gmail.com>
2024-08-07 15:55:23 +00:00
primary: black
accent: blue
toggle:
[Docs 02] Auto dev-docs & more (#2481) * Compile Winutil * pre-Releases (#1) * Create pre-release.yaml * Update release.yaml * Update pre-release.yaml * Create release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update release-drafter.yml * Update pre-release.yaml * Update release-drafter.yml * Update pre-release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Update pre-release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Compile Winutil * fixed end task with right click * Compile Winutil * code generator & compile integration * Compile Winutil * finish - add autogenerated table of content page named "Dev Docs", with table of content to all .md files - added invokescript & undoscript - generate documentation files * oops, remove dublicates * undo winutil.ps1 * remove prefixes WPF WinUtil Toggle $category Features Tweaks Panel Fixes * fixes - fix inconsistency in Featurenaming - add "Enable" & "Disable" as prefix to remove * fix spellin mistake * remove unneccesary whitespaces update info remove unnecessary whitespaces by only adding stuff to the md if it actually exists * rewrite prefix removal into one line definition * added taskscheduler support * add support for function calling add support for functioncalling - replace code formatting for invoke & undo script from json to powershell * content instead of displayname * add last modified date * contributing + docs generator - moved contribute.md to root CONTRIBUTING.md - referenced CONTRIBUTING.md in contribute.md - added toggle & button reference to functions - added function references in functions - changed mkdocs site styling * Use HashSet for processedFunctions Use HashSet for processedFunctions: - Ensures dynamic addition of functions without duplication. Recursive Function Scanning: - Includes all nested functions called by InvokeScript, UndoScript, ToggleScript, and ButtonScript. * follow github standards - add code of conduct - reference code of conduct in docs - regrouped docs navigation - add comment about the sourced md file * small fixes * change color from teal to blue in light mode * add links to tweaks * add archiving feature to autodocs * administrative - add script to releases and remove from compile - move link from after description to after category * small fixes - add S in feature.json - fix dating - move link to after category * fix links * undo link bc of bugs * add progress bar to script - add progress like in compile - moved archive folder creation to the beginning of the script * Simple improvements to 'auto-devdocs' branch (#3) * Fix links for tweaks & features * Make New Line characters work for Json Snippet * Change NewLine Character from Unix Style (LF) to Windows/DOS Style (CRLF) * rerun script * und workflows & rearrange navigation items * layer out itemname cutout * rework links & temp removal of archivation * fix adding link in json root not adding link member to root in json files * fix json generation replace '\r\n',"`r`n" with ('\n',"`n") * add features to auto md docs * add minify plugin * regex hotfix * refractor * add changelog to about section add link to changelog in docs for about section * undo changelog * Cleanup 'devdocs-generator.ps1' - Implement Zig Multiline String Feature (#4) * Cleanup 'devdocs-generator.ps1' - Implement Zig Multiline String Feature * Fix NewLine character replace in 'devdocs-generator.ps1' * run script * run script * Fix 'itemnametocut' RegEx in 'devdocs-generator.ps1' (#5) * rerun script * rework nav + remove code of conduct * undo workflow changes * run script * remove changelog --------- Co-authored-by: MyDrift-user <MyDrift-user@users.noreply.github.com> Co-authored-by: Mr.k <mineshtine28546271@gmail.com>
2024-08-07 15:55:23 +00:00
icon: material/weather-night
name: Switch to light mode
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- abbr
- attr_list
- pymdownx.snippets
- md_in_html
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- def_list
- pymdownx.tasklist:
custom_checkbox: true
[Docs 02] Auto dev-docs & more (#2481) * Compile Winutil * pre-Releases (#1) * Create pre-release.yaml * Update release.yaml * Update pre-release.yaml * Create release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update pre-release.yaml * Update release-drafter.yml * Update pre-release.yaml * Update release-drafter.yml * Update pre-release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Update pre-release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update release.yaml * Update release-drafter.yml * Update release-drafter.yml * Update pre-release.yaml * Compile Winutil * fixed end task with right click * Compile Winutil * code generator & compile integration * Compile Winutil * finish - add autogenerated table of content page named "Dev Docs", with table of content to all .md files - added invokescript & undoscript - generate documentation files * oops, remove dublicates * undo winutil.ps1 * remove prefixes WPF WinUtil Toggle $category Features Tweaks Panel Fixes * fixes - fix inconsistency in Featurenaming - add "Enable" & "Disable" as prefix to remove * fix spellin mistake * remove unneccesary whitespaces update info remove unnecessary whitespaces by only adding stuff to the md if it actually exists * rewrite prefix removal into one line definition * added taskscheduler support * add support for function calling add support for functioncalling - replace code formatting for invoke & undo script from json to powershell * content instead of displayname * add last modified date * contributing + docs generator - moved contribute.md to root CONTRIBUTING.md - referenced CONTRIBUTING.md in contribute.md - added toggle & button reference to functions - added function references in functions - changed mkdocs site styling * Use HashSet for processedFunctions Use HashSet for processedFunctions: - Ensures dynamic addition of functions without duplication. Recursive Function Scanning: - Includes all nested functions called by InvokeScript, UndoScript, ToggleScript, and ButtonScript. * follow github standards - add code of conduct - reference code of conduct in docs - regrouped docs navigation - add comment about the sourced md file * small fixes * change color from teal to blue in light mode * add links to tweaks * add archiving feature to autodocs * administrative - add script to releases and remove from compile - move link from after description to after category * small fixes - add S in feature.json - fix dating - move link to after category * fix links * undo link bc of bugs * add progress bar to script - add progress like in compile - moved archive folder creation to the beginning of the script * Simple improvements to 'auto-devdocs' branch (#3) * Fix links for tweaks & features * Make New Line characters work for Json Snippet * Change NewLine Character from Unix Style (LF) to Windows/DOS Style (CRLF) * rerun script * und workflows & rearrange navigation items * layer out itemname cutout * rework links & temp removal of archivation * fix adding link in json root not adding link member to root in json files * fix json generation replace '\r\n',"`r`n" with ('\n',"`n") * add features to auto md docs * add minify plugin * regex hotfix * refractor * add changelog to about section add link to changelog in docs for about section * undo changelog * Cleanup 'devdocs-generator.ps1' - Implement Zig Multiline String Feature (#4) * Cleanup 'devdocs-generator.ps1' - Implement Zig Multiline String Feature * Fix NewLine character replace in 'devdocs-generator.ps1' * run script * run script * Fix 'itemnametocut' RegEx in 'devdocs-generator.ps1' (#5) * rerun script * rework nav + remove code of conduct * undo workflow changes * run script * remove changelog --------- Co-authored-by: MyDrift-user <MyDrift-user@users.noreply.github.com> Co-authored-by: Mr.k <mineshtine28546271@gmail.com>
2024-08-07 15:55:23 +00:00
- toc:
permalink: true
plugins:
- search
- awesome-pages
- git-revision-date-localized
- minify:
minify_html: true
htmlmin_opts:
remove_comments: true
cache_safe: true