{"id":14235438,"url":"https://github.com/achadwick/zimsearch","last_synced_at":"2025-04-14T00:52:18.180Z","repository":{"id":21234149,"uuid":"24549452","full_name":"achadwick/zimsearch","owner":"achadwick","description":"GNOME Shell search provider for Zim Desktop Wiki, inherited from @dsboger.","archived":false,"fork":false,"pushed_at":"2022-05-29T10:43:41.000Z","size":53,"stargazers_count":19,"open_issues_count":8,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-27T14:55:19.700Z","etag":null,"topics":["gnome-shell","plugin","python","search-provider","zim"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/achadwick.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog","contributing":"Contributing.md","funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-09-28T03:44:11.000Z","updated_at":"2024-11-14T15:59:57.000Z","dependencies_parsed_at":"2022-08-31T02:51:56.102Z","dependency_job_id":null,"html_url":"https://github.com/achadwick/zimsearch","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/achadwick%2Fzimsearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/achadwick%2Fzimsearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/achadwick%2Fzimsearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/achadwick%2Fzimsearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/achadwick","download_url":"https://codeload.github.com/achadwick/zimsearch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248804781,"owners_count":21164131,"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":["gnome-shell","plugin","python","search-provider","zim"],"created_at":"2024-08-20T21:01:55.764Z","updated_at":"2025-04-14T00:52:18.151Z","avatar_url":"https://github.com/achadwick.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# Zim Search plugin for GNOME\n\n[![Build Status](https://travis-ci.org/achadwick/zimsearch.svg?branch=master)](https://travis-ci.org/achadwick/zimsearch)\n\nZimsearch lets you search through your [Zim][] Desktop Wiki pages\ncomfortably from the Activities Overview search box of the GNOME 3\nShell. It acts as a GNOME [desktop search provider][], and also as a\n[Zim plugin][].\n\n## Features\n\n* Fast incremental search of existing Zim pages.\n* Immediate note creation by typing in a new title.\n* Like [nvPY][] or [Notational Velocity][], but feels like part of GNOME.\n* Optionally limit searches to the default notebook only.\n* Select notebooks with special search terms.\n\n## Screenshots\n\nTBD\n\n## Setup\n\nIf you have all the dependencies already:\n\n* Run “`sudo pip install .`” or “`pip install --system .`”\n* Log out and back in again\n\nFor detailed instructions, see the [Installation Guide][].\n\n## Using Zimsearch\n\n### Search for pages\n\nSearch terms typed in the GNOME Shell overview are used to look up Zim\npages from your notebooks. To find an existing page, click on\n\u003csamp\u003eActivities\u003c/samp\u003e in GNOME or press the key that's often decorated\nwith a Windows logo. We'll call it \u003ckbd\u003eMeta\u003c/kbd\u003e for short. If you\nhave a Zim page called “Recipes for Goulash”, you can search for it by typing…\n\n\u003e \u003ckbd\u003eMeta\u003c/kbd\u003e `Recip`\n\nYou might not need to type it all out. Once it's the only matched item\nin all of your the search results, you can press \u003ckbd\u003eReturn\u003c/kbd\u003e\nto open the page in Zim.\n\nPage titles are matched against the search terms and only pages that\ncontain all the terms are shown. By default, all notebooks are searched,\nbut there's a setting in the Zim plugin to limit the search to the\ndefault notebook only.\n\nIt is also possible to limit the search to a certain notebook by adding\na term preceded by a hash sign (`#`). Only notebooks whose names contain\nall the `#` terms are searched.\n\n\u003e \u003ckbd\u003eMeta\u003c/kbd\u003e `Pancake batter #Recipes` \u003ckbd\u003eReturn\u003c/kbd\u003e\n\n### Creating pages\n\nNew pages can be created by typing a complete page title, a little like\n[nvPY][]. When there are no real results, Zimsearch adds some extra\n\"\u003csamp\u003eNew Page …\u003c/samp\u003e\" results. By default a new page goes into your\ndefault notebook, but you can select others with `#` terms as above.\n\n## Development\n\nGitHub: \u003chttps://github.com/achadwick/zimsearch\u003e\n\nSee the [Contributor Guide][] if you'd like to help develop Zimsearch,\nor just get a bug fixed.\n\n### Authors\n\n* Andrew Chadwick (current maintainer)\n* Davi da Silva Böger (original author)\n\n\n[Installation Guide]: INSTALL.md\n[Zim]: http://zim-wiki.org/\n[nvPY]: https://github.com/cpbotha/nvpy\n[Notational Velocity]: http://notational.net\n[desktop search provider]: https://developer.gnome.org/SearchProvider/\n[Zim plugin]: https://github.com/jaap-karssenberg/zim-wiki/wiki/Plugins\n[Contributor Guide]: Contributing.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fachadwick%2Fzimsearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fachadwick%2Fzimsearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fachadwick%2Fzimsearch/lists"}