starting documentation with mkdocs

docs/extract-audio.md

@@ -0,0 +1,53 @@
+The `extract-audio` command is designed to detach the audio component from a video file. Whether you're repurposing the audio content of videos for podcasts, transcription, or other audio-centric endeavors, this tool provides a seamless experience.
+
+## Features:
+
+- **Dual Audio Extraction with `--eq` Flag**: 
+  - When you use the `--eq` flag, the command produces two distinct audio files:
+    1. A pure audio file extracted directly from the video.
+    2. An enhanced audio file where compression is applied, and the volume is amplified by 10 decibels.
+  - This gives users the flexibility to have both the raw and enhanced versions for various applications.
+
+- **Default Output**: If an `output_file` isn't specified, the extracted audio will default to `output.wav`. If `--eq` is used, the enhanced version might have a suffix or different naming to differentiate it from the raw audio.
+
+- **Opt-Out of Audio Enhancement**: If you only want the raw, unaltered audio without the enhanced version, simply use the `--no-eq` flag.
+
+## Example Usage:
+
+To extract both raw and enhanced audio from a video named `presentation.mp4`:
+
+```
+vmh extract-audio presentation.mp4 --eq
+```
+
+For raw audio extraction without any enhancement:
+
+```
+vmh extract-audio presentation.mp4 --no-eq
+```
+
+## `--help` Flag Output:
+
+For a detailed breakdown of the available options and arguments for the `extract-audio` command:
+
+```
+vmh extract-audio --help
+
+ Usage: vmh extract-audio [OPTIONS] AUDIO_FILE [OUTPUT_FILE]
+
+ Extracts the audio from a video.
+
+╭─ Arguments ──────────────────────────────────────────────────────────────────╮
+│ *    audio_file       PATH           [default: None] [required]              │
+│      output_file      [OUTPUT_FILE]  [default: output.wav]                   │
+╰──────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ────────────────────────────────────────────────────────────────────╮
+│ --eq      --no-eq      Add compression and 10db of extracted audio           │
+│                        [default: eq]                                         │
+│ --help                 Show this message and exit.                           │
+╰──────────────────────────────────────────────────────────────────────────────╯
+```
+
+## API for developers
+
+::: vmh.audio.extract_audio

docs/index.md

@@ -0,0 +1,26 @@
+# 📹 VideoMaker Helper
+
+VideoMaker Helper is a collection of command-line utilities designed to simplify common tasks for video and audio content creators. These tools aim to automate specific aspects of the video-making process, reducing manual work and enhancing overall efficiency.
+
+## 🥝 Core Features:
+
+- **Silence Detection**: Automatically detect silent segments in audio files. Useful for determining parts to edit or skip.
+
+- **Audio Equalization**: Adjust the audio to a consistent level across a file. This tool can add compression and gain to improve the listening experience.
+
+- **Audio Extraction**: Pull audio content from video files. With an option to receive both the raw extracted audio and an equalized version.
+
+- **Video Editing**: Based on silence detection, automatically cut portions of a video, providing a streamlined content experience. See the examples at [**video-cut examples**](https://github.com/dunossauro/videomaker-helper/tree/main/examples/cut-video)
+
+## Installation:
+
+To install VideoMaker Helper, simply use the following command:
+
+```bash
+pipx install git+https://github.com/dunossauro/videomaker-helper.git
+```
+
+With VideoMaker Helper installed, you can easily run any of the included tools from your terminal. It's a practical toolset for anyone looking to expedite their content creation process.
+
+
+![type:video](videos/result_large.mp4){: disable-global-config style='width: 100%'}

mkdocs.yml

@@ -0,0 +1,16 @@
+site_name: VideoMaker-Helper
+
+theme:
+  name: material
+
+plugins:
+  - mkdocs-video:
+      is_video: True
+      video_type: mp4
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [vmh]
+
+watch:
+   - vmh