{"id":30810568,"url":"https://github.com/nuuner/docx-navigator","last_synced_at":"2025-09-06T05:51:51.739Z","repository":{"id":309712042,"uuid":"1037266574","full_name":"nuuner/docx-navigator","owner":"nuuner","description":"Merge multiple DOCX files into one Word document with a clickable menu, back-to-menu links, and preserved formatting.","archived":false,"fork":false,"pushed_at":"2025-08-13T10:45:13.000Z","size":16,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-13T12:31:33.242Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nuuner.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-13T10:09:45.000Z","updated_at":"2025-08-13T10:45:17.000Z","dependencies_parsed_at":"2025-08-13T12:31:35.775Z","dependency_job_id":"2e81a7a5-2014-40a8-8def-c0c937a02e4b","html_url":"https://github.com/nuuner/docx-navigator","commit_stats":null,"previous_names":["nuuner/docx-navigator"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/nuuner/docx-navigator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuuner%2Fdocx-navigator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuuner%2Fdocx-navigator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuuner%2Fdocx-navigator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuuner%2Fdocx-navigator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nuuner","download_url":"https://codeload.github.com/nuuner/docx-navigator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuuner%2Fdocx-navigator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273862618,"owners_count":25181546,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-06T02:00:13.247Z","response_time":2576,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-06T05:51:50.649Z","updated_at":"2025-09-06T05:51:51.730Z","avatar_url":"https://github.com/nuuner.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DOCX Navigator\n\nMerge multiple Word (`.docx`) files into a single document with:\n\n* A **clickable menu** linking to each document’s start\n* **“Back to menu”** links at the top of each section\n* Automatic **page breaks** between merged documents\n* Preserves original formatting, images, and styles\n\n## Features\n\n* **Auto-discovery**: Automatically finds all `.docx` files in current directory\n* Groups files by the `\u003ccategory\u003e_\u003cdocument name\u003e.docx` pattern\n* Internal bookmarks + hyperlinks (no MS Word required)\n* Cross-platform (uses `python-docx` + `docxcompose`)\n\n---\n\n## Quickstart\n\n\u003e Requires: [uv](https://github.com/astral-sh/uv) installed.\n\n```bash\n# Automatically merges all .docx files in current directory\nuv run --with . docx-navigator\n\n# Or specify files explicitly\nuv run --with . docx-navigator --inputs file1.docx file2.docx\n```\n\nNo configuration needed! Just run the command in a directory with `.docx` files.\nOutput will be `all_documents.docx` by default.\n\n---\n\n## CLI Options\n\n```bash\nuv run --with . docx-navigator [OPTIONS]\n```\n\n**Main Options**\n\n| Option           | Default              | Description                                                                            |\n| ---------------- | -------------------- | -------------------------------------------------------------------------------------- |\n| `--inputs`       | *auto-detect*        | Explicit list of `.docx` files to merge. If not provided, uses all `.docx` files in current directory. |\n| `--output`       | `all_documents.docx` | Output file path/name.                                                                |\n| `--menu-title`   | `Menu`               | Heading text for the clickable menu.                                                  |\n| `--back-label`   | `Back to menu`       | Label for the backlink at the start of each section.                                  |\n| `--category-sep` | `_`                  | Separator between category and document name in filenames.                            |\n| `--dry-run`      | off                  | Preview what would be merged without writing output file.                             |\n\n\u003e The tool groups files by the `\u003ccategory\u003e_\u003cdocument name\u003e.docx` pattern using `--category-sep`. Anything before the first separator is treated as the category.\n\n### Examples\n\n**1) Basic usage - merge all .docx files in current directory**\n\n```bash\nuv run docx-navigator\n```\n\n**2) Merge specific files**\n\n```bash\nuv run docx-navigator \\\n  --inputs \"Finance_Q1.docx\" \"Finance_Q2.docx\" \\\n  --output \"Finance_Reports.docx\"\n```\n\n**3) Preview without creating output**\n\n```bash\nuv run docx-navigator --dry-run\n```\n\n**4) Customize menu and labels**\n\n```bash\nuv run docx-navigator \\\n  --menu-title \"Document Index\" \\\n  --back-label \"Return to Index\"\n```\n\n---\n\n## Example\n\n**Input files**\n\n```\nFinance_Quarterly Report Q1.docx\nFinance_Quarterly Report Q2.docx\nHR_Employee Handbook.docx\nHR_Payroll Guidelines.docx\nMarketing_Brand Guidelines.docx\nMarketing_Campaign Plan 2025.docx\n```\n\n**Output menu structure**\n\n```\nFinance\n  Quarterly Report Q1\n  Quarterly Report Q2\nHR\n  Employee Handbook\n  Payroll Guidelines\nMarketing\n  Brand Guidelines\n  Campaign Plan 2025\n```\n\n* Clicking an entry in the menu jumps to the corresponding document section.\n* Each section starts with a **Back to menu** link for quick navigation.\n* Page breaks separate each appended document.\n\n---\n\n## Installation\n\nEnsure you have [uv](https://github.com/astral-sh/uv) installed.\nYou can either install the CLI permanently or run it directly from the project directory.\n\n### Option 1 — Run without installing\n\n```bash\nuv run --with . docx-navigator\n```\n\nThe `--with .` flag tells `uv` to include the current project in the temporary environment before running.\n\n### Option 2 — Install locally\n\n```bash\nuv pip install -e .\ndocx-navigator\n```\n\nThis makes the `docx-navigator` command available anywhere in your environment.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuuner%2Fdocx-navigator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnuuner%2Fdocx-navigator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuuner%2Fdocx-navigator/lists"}