Merge pull request #144 from RafaelJohn9/develop

Develop

Author: RafaelJohn9

.github/workflows/deploy-docs.yml

@@ -0,0 +1,54 @@
+name: Deploy Docs to GitHub Pages
+
+on:
+  push:
+    branches: [main, master]  # or your default branch
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          cache: 'npm'
+          cache-dependency-path: './docs/package-lock.json'
+
+      - name: Install dependencies
+        run: |
+          cd docs
+          npm ci
+
+      - name: Build website
+        run: |
+          cd docs
+          npm run build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: './docs/build'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+## Installation
+
+```bash
+yarn
+```
+
+## Local Development
+
+```bash
+yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+## Build
+
+```bash
+yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+## Deployment
+
+Using SSH:
+
+```bash
+USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```bash
+GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/docs/commands/gitignore/gitignore-add.md

@@ -0,0 +1,229 @@
+---
+title: "gh-templates gitignore add"
+sidebar_label: "gitignore add"
+---
+
+# Add Gitignore Templates
+
+Add one or more gitignore templates to your repository.
+
+## Usage
+
+```bash
+gh-templates gitignore add [OPTIONS] [TEMPLATE]...
+```
+
+## Arguments
+
+| Argument        | Description                                                      |
+|-----------------|------------------------------------------------------------------|
+| `[TEMPLATE]...` | Gitignore template names to add (e.g., rust, python, global/windows) |
+
+## Options
+
+| Option                        | Description                                                                 |
+|-------------------------------|-----------------------------------------------------------------------------|
+| `--dir <DIR>`                 | Directory to save the `.gitignore` file                                     |
+| `--force`                     | Force overwrite existing `.gitignore` file                                  |
+| `--all`                       | Download all available templates                                            |
+| `-a, --append`                | Append to the existing `.gitignore` file instead of overwriting             |
+| `--update-cache`              | Update the gitignore template cache                                         |
+| `-n, --use-remote-name`       | Use the remote template file name as the output file name                   |
+| `-o, --output <FILENAME>...`  | Output file name(s) (default: `.gitignore`)                                 |
+| `-h, --help`                  | Print help                                                                 |
+
+## Examples
+
+### Add a Single Template
+
+```bash
+gh-templates gitignore add rust
+```
+
+Downloads the Rust gitignore template and saves it as `.gitignore` in the repository root.
+
+### Add Multiple Templates
+
+```bash
+gh-templates gitignore add rust docker vscode
+```
+
+Combines multiple gitignore templates into a single comprehensive file.
+
+### Custom Output Directory
+
+```bash
+gh-templates gitignore add python --dir backend/
+```
+
+Saves the gitignore file to a custom directory (useful for monorepos).
+
+### Custom File Names
+
+```bash
+gh-templates gitignore add rust python -o .gitignore.rust -o .gitignore.python
+```
+
+Creates separate gitignore files for each template.
+
+### Force Overwrite
+
+```bash
+gh-templates gitignore add node --force
+```
+
+Overwrites existing `.gitignore` file without prompting.
+
+### Add All Templates
+
+```bash
+gh-templates gitignore add --all
+```
+
+Downloads and combines all available gitignore templates (creates a very comprehensive file ~ Not Recommended).
+
+### Append to Existing File
+
+```bash
+gh-templates gitignore add python --append
+```
+
+Appends the Python template to the existing `.gitignore` file.
+
+### Use Remote Template Name
+
+```bash
+gh-templates gitignore add rust -n
+```
+
+Saves the template using its remote file name (e.g., `Rust.gitignore`).
+
+### Update Template Cache
+
+```bash
+gh-templates gitignore add --update-cache
+```
+
+Updates the local cache of available gitignore templates.
+
+### Complex Example
+
+```bash
+gh-templates gitignore add rust docker windows --dir . --force -o .gitignore
+```
+
+This command:
+
+- Adds Rust, Docker, and Windows gitignore patterns
+- Saves to repository root directory
+- Forces overwrite of existing file
+- Uses explicit output filename
+
+## Default Behavior
+
+- **Output Directory**: Repository root (`.`)
+- **File Names**: `.gitignore` (single file containing all patterns)
+- **Overwrite**: Prompts before overwriting existing files (unless `--force` is used)
+- **Append**: By default, overwrites unless `--append` is specified
+- **Combination**: Multiple templates are merged into one file
+
+## Template Combination
+
+When adding multiple templates, `gh-templates` intelligently combines them:
+
+1. **Categorization**: Groups patterns by category with comments
+
+## Best Practices for Combining
+
+### Language + OS + Editor
+
+```bash
+gh-templates gitignore add python windows vscode
+```
+
+### Full Stack Project
+
+```bash
+gh-templates gitignore add javascript python docker
+```
+
+### Polyglot Repository
+
+```bash
+gh-templates gitignore add rust go python java
+```
+
+## Monorepo Strategy
+
+For monorepos with multiple projects:
+
+```bash
+# Root-level common ignores
+gh-templates gitignore add windows macos linux
+
+# Language-specific ignores in subdirectories
+gh-templates gitignore add rust --dir rust-service/
+gh-templates gitignore add node --dir web-frontend/
+gh-templates gitignore add python --dir python-api/
+```
+
+## Updating Gitignore
+
+To update an existing `.gitignore`:
+
+1. **Preview changes** first:
+
+   ```bash
+   gh-templates gitignore preview rust
+   ```
+
+2. **Backup existing** file:
+
+   ```bash
+   cp .gitignore .gitignore.backup
+   ```
+
+3. **Update with force**:
+
+   ```bash
+   gh-templates gitignore add rust --force
+   ```
+
+## Common Combinations
+
+| Project Type      | Recommended Templates         |
+|-------------------|-----------------------------|
+| Rust desktop app  | `rust windows macos linux`  |
+| Python web app    | `python docker vscode`      |
+| Node.js project   | `node windows macos`        |
+| Full-stack app    | `javascript python docker`  |
+| Mobile app        | `java kotlin swift xcode`   |
+| Data science      | `python jupyter r`          |
+
+## Troubleshooting
+
+### File Already Exists
+
+Without `--force`, you'll be prompted to overwrite. Options:
+
+- Use `--force` to overwrite
+- Use `--append` to add to the existing file
+- Use different output name with `-o`
+- Manually merge the content
+
+### Patterns Not Working
+
+If ignore patterns aren't working:
+
+1. Ensure file is named `.gitignore`
+2. Check file is in repository root or appropriate subdirectory
+3. Commit the `.gitignore` file
+4. Use `git rm --cached <file>` to untrack already-tracked files
+
+## Tips
+
+1. **Start Early**: Add `.gitignore` before committing code
+2. **Be Specific**: Choose templates that match your actual tech stack
+3. **Review Content**: Preview templates to understand what they ignore
+4. **Combine Wisely**: Don't add unnecessary templates that create noise
+5. **Update Regularly**: Refresh gitignore as your project evolves