diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..618cf95 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,53 @@ +name: Deploy Documentation + +on: + push: + branches: + - main + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: true + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v6 + + - name: Setup Python + uses: actions/setup-python@v6 + with: + python-version: '3.13' + + - name: Install documentation dependencies + run: python -m pip install --upgrade pip && python -m pip install -r docs/requirements.txt + + - name: Build site + run: mkdocs build -f docs/mkdocs.yml --site-dir site + + - name: Configure Pages + uses: actions/configure-pages@v5 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v4 + with: + path: site + + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/README.md b/README.md index 8fd7900..c4fd694 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ Working with multiple directories and execute commands without navigate to them

+ Documentation • Downloads • Issues

@@ -28,7 +29,7 @@ Working with multiple directories and execute commands without navigate to them ## About -![Workdir](/images/workdir.png "Workdir") +![Workdir](docs/docs/assets/screenshots/workdir.png "Workdir") My tool **Workdir** is one of the oldest tools I use. I have not been navigating back and forth between directories for over ten years now. I press a button and open my directories directly. I can also start executing commands with one click. With another button I directly start the command line. And sometimes I directly start a command inside the directory. This makes working with directories much easier. @@ -38,7 +39,7 @@ You can *theoretically* specify an unlimited number of directories. Up to six in Download the [latest release](https://github.com/dseichter/Workdir/releases) into a destination folder of your choice and start the program. Via the configuration (menu Extras) you can specify your directories and store up to six commands. -![Workdir - Configuration](/images/configuration.png "Workdir - Configuration") +![Workdir - Configuration](docs/docs/assets/screenshots/configuration.png "Workdir - Configuration") Please note that in the current version you can only specify the directory itself as a placeholder. The examples for CMD and Windows Explorer should help you to implement your own calls. Once you click Save, the commands and directories are immediately available in the Directories tab. diff --git a/docs/docs/assets/folder_open_24dp_8B1A10_FILL0_wght400_GRAD0_opsz24.png b/docs/docs/assets/folder_open_24dp_8B1A10_FILL0_wght400_GRAD0_opsz24.png new file mode 100644 index 0000000..df2dfc9 Binary files /dev/null and b/docs/docs/assets/folder_open_24dp_8B1A10_FILL0_wght400_GRAD0_opsz24.png differ diff --git a/docs/docs/assets/folder_open_48dp_8B1A10_FILL0_wght400_GRAD0_opsz48.png b/docs/docs/assets/folder_open_48dp_8B1A10_FILL0_wght400_GRAD0_opsz48.png new file mode 100644 index 0000000..419b5e1 Binary files /dev/null and b/docs/docs/assets/folder_open_48dp_8B1A10_FILL0_wght400_GRAD0_opsz48.png differ diff --git a/images/configuration.png b/docs/docs/assets/screenshots/configuration.png similarity index 100% rename from images/configuration.png rename to docs/docs/assets/screenshots/configuration.png diff --git a/images/workdir.png b/docs/docs/assets/screenshots/workdir.png similarity index 100% rename from images/workdir.png rename to docs/docs/assets/screenshots/workdir.png diff --git a/docs/docs/index.md b/docs/docs/index.md new file mode 100644 index 0000000..6c950ec --- /dev/null +++ b/docs/docs/index.md @@ -0,0 +1,39 @@ +# Workdir + +![ruff](https://github.com/dseichter/Workdir/actions/workflows/ruff.yml/badge.svg) +![bandit](https://github.com/dseichter/Workdir/actions/workflows/bandit.yml/badge.svg) +![trivy](https://github.com/dseichter/Workdir/actions/workflows/trivy.yml/badge.svg) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=dseichter_Workdir&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=dseichter_Workdir) + +Workdir helps you work with multiple directories and run commands without manually navigating to each location. + +![Workdir](assets/screenshots/workdir.png) + +Binaries for Windows and Linux are available (see [releases](https://github.com/dseichter/Workdir/releases)). + +[![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/dseichter/Workdir/total)](https://github.com/dseichter/Workdir/releases) +![GitHub License](https://img.shields.io/github/license/dseichter/Workdir) +[![GitHub Issues](https://img.shields.io/github/issues/dseichter/Workdir)](https://github.com/dseichter/Workdir/issues) +[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/dseichter/Workdir)](https://github.com/dseichter/Workdir/pulls) + +## Features + +- Manage many directories from one UI +- Configure up to six commands per directory +- Use confirmation prompts for sensitive commands +- Attach additional environment variables for execution +- Reuse Workdir with multiple independent configurations + +## Installation and Configuration + +Download the [latest release](https://github.com/dseichter/Workdir/releases) into a destination folder of your choice and start the program. + +Via the configuration (menu Extras) you can specify your directories and store up to six commands. + +![Workdir Configuration](assets/screenshots/configuration.png) + +Please always specify the directories using the placeholder `{directory}`. This value is replaced automatically when commands are executed. + +## Known Issues + +If you run Workdir the first time, the window can be very small. The size is automatically adjusted based on your configured directories. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000..58c5471 --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,41 @@ +site_name: Workdir +site_url: https://dseichter.github.io/Workdir/ +site_description: Working with multiple directories and execute commands without navigate to them. +site_author: Daniel Seichter +copyright: Copyright © 2024-2026 Daniel Seichter +repo_url: https://github.com/dseichter/Workdir +repo_name: dseichter/Workdir + +theme: + name: material + logo: assets/folder_open_48dp_8B1A10_FILL0_wght400_GRAD0_opsz48.png + favicon: assets/folder_open_24dp_8B1A10_FILL0_wght400_GRAD0_opsz24.png + icon: + alternate: fontawesome/solid/globe + palette: + - scheme: slate + primary: cyan + accent: green + toggle: + icon: material/weather-sunny + name: Switch to light mode + default: true + - scheme: default + primary: cyan + accent: green + toggle: + icon: material/weather-night + name: Switch to dark mode + +nav: + - Home: index.md + +markdown_extensions: + - attr_list + - footnotes + - admonition + - pymdownx.details + - pymdownx.superfences + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..ac43bad --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +mkdocs==1.6.1 +mkdocs-material==9.7.2