{"id":24204534,"url":"https://github.com/tombreit/zammadkb2mkdocs","last_synced_at":"2026-05-10T11:48:37.079Z","repository":{"id":272207072,"uuid":"915467096","full_name":"tombreit/zammadkb2mkdocs","owner":"tombreit","description":"Exports a Zammad Knowledge Base to MkDocs","archived":false,"fork":false,"pushed_at":"2025-01-23T20:41:53.000Z","size":24,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-23T21:29:01.894Z","etag":null,"topics":["mkdocs","zammad"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"eupl-1.2","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tombreit.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}},"created_at":"2025-01-11T23:06:56.000Z","updated_at":"2025-01-23T20:41:46.000Z","dependencies_parsed_at":"2025-01-12T23:29:06.265Z","dependency_job_id":"398beb19-aaa4-4486-9997-241c8e039a19","html_url":"https://github.com/tombreit/zammadkb2mkdocs","commit_stats":null,"previous_names":["tombreit/zammadkb2mkdocs"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombreit%2Fzammadkb2mkdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombreit%2Fzammadkb2mkdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombreit%2Fzammadkb2mkdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombreit%2Fzammadkb2mkdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tombreit","download_url":"https://codeload.github.com/tombreit/zammadkb2mkdocs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241663488,"owners_count":19999325,"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","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":["mkdocs","zammad"],"created_at":"2025-01-13T23:17:06.559Z","updated_at":"2026-05-10T11:48:32.044Z","avatar_url":"https://github.com/tombreit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\nSPDX-FileCopyrightText: Thomas Breitner\n\nSPDX-License-Identifier: EUPL-1.2\n--\u003e\n\n# zammadkb2mkdocs\n\n## Features\n\n- `zammadkb2mkdocs` takes a Zammad database file and converts the Zammad Knowledge Base to a `MkDocs` project\n- Converts Zammad source HTML to Markdown\n- Converts multilanguage Knowledge Base to multilanguage MkDocs\n- Downloads referenced images and adjusts the image links\n- Grabs the Zammad Knowledge Base categories and converts them to MkDocs tags\n\n## Requirements\n\n- `python3`\n- `sqlite3`\n- Zammad database must be available as a SQLite3 database file. See [Database](#database).\n\n## Usage\n\n**🔥 This is work in progress - no liability for nothing.**\n\n### Install\n\n```bash\npython3 -m venv .venv\nsource .venv/bin/activate\npython3 -m pip install 'zammadkb2mkdocs @ git+https://github.com/tombreit/zammadkb2mkdocs'\n```\n\n### Run\n\n```bash\nzammadkb2mkdocs path/to/zammad-sqlite-dbfile --zammad-fqdn zammad.example.org\n```\n\n### Result\n\nThe Zammad Knowledge Base articles converted to Markdown files end up in `./dist/docs`.\nSome other intermediate files such as the JSON representation of the Zammad Knowledge Base are also stored in `./dist`.\n\nFor your convenience, `mkdocs` will be installed with this package and you can view your new MkDocs knowledgebase base right now:\n\n```bash\nmkdocs serve\n```\n\n## Notes\n\n- Currently only used/tested with a Zammad Knowledge Base in EN and DE.\n- If the given `zammad-fqdn` is not reachable image src attributes will not be fixed and no images will be downloaded.\n- To start from scratch: delete the automatically populated `./dist` directory.\n\n## Database\n\n### Create PostgreSQL dump\n\n```bash\n@\u003cyour-zammad-host\u003e:~$ pg_dump \\\n    --port \u003cyour-zammad-port:5432\u003e \\\n    --username \u003cyour-zammad-db-username:zammad\u003e \\\n    --disable-dollar-quoting --no-security-labels \\\n    --no-subscriptions --no-table-access-method \\\n    --no-owner --no-privileges --no-comments \\\n    --attribute-inserts \\\n    zammad \u003e path/to/dump.sql\n```\n\n### PostgreSQL dump to SQLite3\n\nThis package includes a rudimentary conversion script:\n\n```bash\npgsql2sqlite path/to/dump.sql\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftombreit%2Fzammadkb2mkdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftombreit%2Fzammadkb2mkdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftombreit%2Fzammadkb2mkdocs/lists"}