Nipun Claude commited on
Commit
6fa1cfa
·
1 Parent(s): 2158b56

Add GitHub Pages and update to video-toolkit branding

Browse files

- Add comprehensive .gitignore for video processing projects
- Set up GitHub Pages with Jekyll and GitHub Actions deployment
- Configure single-source documentation using README.md
- Update all URLs and references to new repository name 'video-toolkit'
- Add GitHub Pages configuration with responsive theme
- Enable automatic deployment on push to main branch

GitHub Pages will be available at: https://nipunbatra.github.io/video-toolkit

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

Files changed (6) hide show
  1. .github/workflows/pages.yml +48 -0
  2. .gitignore +75 -0
  3. Readme.md +5 -5
  4. docs/README.md +48 -0
  5. docs/_config.yml +54 -0
  6. docs/index.md +6 -0
.github/workflows/pages.yml ADDED
@@ -0,0 +1,48 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Deploy GitHub Pages
2
+
3
+ on:
4
+ push:
5
+ branches: [ main ]
6
+ pull_request:
7
+ branches: [ main ]
8
+
9
+ # Allow one concurrent deployment
10
+ concurrency:
11
+ group: pages
12
+ cancel-in-progress: true
13
+
14
+ jobs:
15
+ # Build job
16
+ build:
17
+ runs-on: ubuntu-latest
18
+ steps:
19
+ - name: Checkout
20
+ uses: actions/checkout@v4
21
+
22
+ - name: Setup Pages
23
+ uses: actions/configure-pages@v4
24
+
25
+ - name: Build with Jekyll
26
+ uses: actions/jekyll-build-pages@v1
27
+ with:
28
+ source: ./docs
29
+ destination: ./_site
30
+
31
+ - name: Upload artifact
32
+ uses: actions/upload-pages-artifact@v3
33
+
34
+ # Deployment job
35
+ deploy:
36
+ environment:
37
+ name: github-pages
38
+ url: ${{ steps.deployment.outputs.page_url }}
39
+ runs-on: ubuntu-latest
40
+ needs: build
41
+ permissions:
42
+ pages: write
43
+ id-token: write
44
+ if: github.ref == 'refs/heads/main'
45
+ steps:
46
+ - name: Deploy to GitHub Pages
47
+ id: deployment
48
+ uses: actions/deploy-pages@v4
.gitignore ADDED
@@ -0,0 +1,75 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # macOS
2
+ .DS_Store
3
+ .DS_Store?
4
+ ._*
5
+ .Spotlight-V100
6
+ .Trashes
7
+ ehthumbs.db
8
+ Thumbs.db
9
+
10
+ # Video processing outputs
11
+ *.mp4
12
+ *.avi
13
+ *.mov
14
+ *.mkv
15
+ *.webm
16
+ *.flv
17
+ *.wmv
18
+
19
+ # Audio processing outputs
20
+ *.aac
21
+ *.mp3
22
+ *.wav
23
+ *.flac
24
+ *.ogg
25
+ *.m4a
26
+
27
+ # Temporary files
28
+ *.tmp
29
+ *.temp
30
+ *~
31
+ *.swp
32
+ *.swo
33
+
34
+ # Logs
35
+ *.log
36
+ ffmpeg*.log
37
+
38
+ # IDE/Editor files
39
+ .vscode/
40
+ .idea/
41
+ *.sublime-project
42
+ *.sublime-workspace
43
+
44
+ # Node.js (if adding any JS tools)
45
+ node_modules/
46
+ npm-debug.log*
47
+ yarn-debug.log*
48
+ yarn-error.log*
49
+
50
+ # Python (if adding any Python tools)
51
+ __pycache__/
52
+ *.py[cod]
53
+ *$py.class
54
+ *.so
55
+ .env
56
+ venv/
57
+ env/
58
+
59
+ # Build artifacts
60
+ build/
61
+ dist/
62
+ *.tar.gz
63
+ *.zip
64
+
65
+ # Test outputs
66
+ test_output/
67
+ test_videos/
68
+
69
+ # Personal/local config
70
+ .local/
71
+ config.local.*
72
+
73
+ # Demo video exceptions (keep these)
74
+ !demo/sample-*.mp4
75
+ !demo/sample-*.aac
Readme.md CHANGED
@@ -1,4 +1,4 @@
1
- # Video Processing Tool
2
 
3
  A fast and efficient command-line tool for trimming MP4 videos with minimal processing and automatic audio extraction. This tool prioritizes speed by using stream copying when possible, falling back to re-encoding only when necessary for precision.
4
 
@@ -30,7 +30,7 @@ A fast and efficient command-line tool for trimming MP4 videos with minimal proc
30
 
31
  **Step 1:** Download and make executable in one step
32
  ```bash
33
- curl -O https://raw.githubusercontent.com/nipunbatra/trim-convert/main/trim-convert.sh && chmod +x trim-convert.sh
34
  ```
35
 
36
  **Step 2:** Verify the script works
@@ -42,8 +42,8 @@ curl -O https://raw.githubusercontent.com/nipunbatra/trim-convert/main/trim-conv
42
 
43
  **Step 1:** Clone this repository
44
  ```bash
45
- git clone https://github.com/nipunbatra/trim-convert.git
46
- cd trim-convert
47
  ```
48
 
49
  **Step 2:** Make the script executable
@@ -217,7 +217,7 @@ All demo videos are verified to be free to use, modify, and distribute.
217
 
218
  ## License
219
 
220
- MIT License - See [LICENSE](LICENSE) file for details
221
 
222
  ## Contributing
223
 
 
1
+ # Video Toolkit
2
 
3
  A fast and efficient command-line tool for trimming MP4 videos with minimal processing and automatic audio extraction. This tool prioritizes speed by using stream copying when possible, falling back to re-encoding only when necessary for precision.
4
 
 
30
 
31
  **Step 1:** Download and make executable in one step
32
  ```bash
33
+ curl -O https://raw.githubusercontent.com/nipunbatra/video-toolkit/main/trim-convert.sh && chmod +x trim-convert.sh
34
  ```
35
 
36
  **Step 2:** Verify the script works
 
42
 
43
  **Step 1:** Clone this repository
44
  ```bash
45
+ git clone https://github.com/nipunbatra/video-toolkit.git
46
+ cd video-toolkit
47
  ```
48
 
49
  **Step 2:** Make the script executable
 
217
 
218
  ## License
219
 
220
+ MIT License - See [LICENSE](https://github.com/nipunbatra/video-toolkit/blob/main/LICENSE) file for details
221
 
222
  ## Contributing
223
 
docs/README.md ADDED
@@ -0,0 +1,48 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # GitHub Pages Documentation
2
+
3
+ This directory contains the GitHub Pages configuration for the Video Processing Tool documentation website.
4
+
5
+ ## Setup
6
+
7
+ The site is automatically deployed using GitHub Actions when changes are pushed to the main branch.
8
+
9
+ ### Files
10
+
11
+ - `index.md` - Main documentation page (mirrors the repository README)
12
+ - `_config.yml` - Jekyll configuration for GitHub Pages
13
+ - `../.github/workflows/pages.yml` - GitHub Actions workflow for deployment
14
+
15
+ ### Local Development
16
+
17
+ To run the site locally:
18
+
19
+ 1. Install Jekyll and dependencies:
20
+ ```bash
21
+ gem install jekyll bundler
22
+ bundle install
23
+ ```
24
+
25
+ 2. Serve the site:
26
+ ```bash
27
+ bundle exec jekyll serve --source docs
28
+ ```
29
+
30
+ 3. Open http://localhost:4000 in your browser
31
+
32
+ ### Theme
33
+
34
+ The site uses the default GitHub Pages theme (minima) with:
35
+ - Responsive design
36
+ - Syntax highlighting for code blocks
37
+ - SEO optimization
38
+ - Automatic sitemap generation
39
+
40
+ ### Customization
41
+
42
+ To customize the appearance:
43
+ 1. Edit `_config.yml` for site-wide settings
44
+ 2. Add custom CSS in `assets/css/style.scss`
45
+ 3. Override theme layouts in `_layouts/`
46
+ 4. Add custom includes in `_includes/`
47
+
48
+ The site will be available at: https://nipunbatra.github.io/video-toolkit
docs/_config.yml ADDED
@@ -0,0 +1,54 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ title: Video Toolkit
2
+ description: A fast and efficient command-line tool for trimming MP4 videos with minimal processing and automatic audio extraction
3
+ url: https://nipunbatra.github.io/video-toolkit
4
+ baseurl: /video-toolkit
5
+
6
+ # Jekyll configuration
7
+ theme: minima
8
+ plugins:
9
+ - jekyll-feed
10
+ - jekyll-sitemap
11
+ - jekyll-seo-tag
12
+
13
+ # GitHub Pages configuration
14
+ repository: nipunbatra/video-toolkit
15
+ github:
16
+ repository_url: https://github.com/nipunbatra/video-toolkit
17
+
18
+ # Site settings
19
+ author:
20
+ name: Nipun Batra
21
+ email: nipun.batra@gmail.com
22
+
23
+ # SEO settings
24
+ logo: /assets/images/logo.png
25
+ twitter:
26
+ username: nipunbatra
27
+ card: summary
28
+
29
+ # Navigation
30
+ header_pages:
31
+ - index.md
32
+
33
+ # Markdown settings
34
+ markdown: kramdown
35
+ highlighter: rouge
36
+ kramdown:
37
+ input: GFM
38
+ syntax_highlighter: rouge
39
+
40
+ # Exclude from processing
41
+ exclude:
42
+ - Gemfile
43
+ - Gemfile.lock
44
+ - node_modules
45
+ - vendor/bundle/
46
+ - vendor/cache/
47
+ - vendor/gems/
48
+ - vendor/ruby/
49
+ - .gitignore
50
+ - .git/
51
+
52
+ # Include
53
+ include:
54
+ - _pages
docs/index.md ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+ ---
2
+ title: Video Toolkit
3
+ description: A fast and efficient command-line tool for trimming MP4 videos with minimal processing and automatic audio extraction
4
+ ---
5
+
6
+ {% include_relative ../README.md %}