{"id":22656886,"url":"https://github.com/icelk/kvarn-search","last_synced_at":"2025-04-11T13:08:05.066Z","repository":{"id":57634758,"uuid":"445846754","full_name":"Icelk/kvarn-search","owner":"Icelk","description":"Search engine integration with Kvarn. Takes 5 minutes to set up on your website.","archived":false,"fork":false,"pushed_at":"2024-05-25T21:29:09.000Z","size":73,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-25T09:21:21.962Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Icelk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","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":"2022-01-08T14:49:56.000Z","updated_at":"2024-05-25T21:29:11.000Z","dependencies_parsed_at":"2025-02-03T21:45:26.439Z","dependency_job_id":"d44ca506-9172-44e9-8ab9-b92f0b6efaa2","html_url":"https://github.com/Icelk/kvarn-search","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icelk%2Fkvarn-search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icelk%2Fkvarn-search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icelk%2Fkvarn-search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icelk%2Fkvarn-search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Icelk","download_url":"https://codeload.github.com/Icelk/kvarn-search/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248404605,"owners_count":21097780,"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":[],"created_at":"2024-12-09T10:16:48.704Z","updated_at":"2025-04-11T13:08:05.042Z","avatar_url":"https://github.com/Icelk.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![crates.io version](https://img.shields.io/crates/v/kvarn-search)](https://crates.io/crates/kvarn-search)\n![lines of code](https://tokei.rs/b1/github/Icelk/kvarn-search?style=flat)\n![license](https://img.shields.io/github/license/Icelk/kvarn-search)\n\n# [Kvarn search](https://kvarn.org/search.)\n\nUses [elipdotter](https://github.com/Icelk/elipdotter)\nto provide search capabilities for a Kvarn host.\n\nUses the file system and [`prepare_single`](https://doc.kvarn.org/kvarn/extensions/struct.Extensions.html#method.get_prepare_single)\nextensions to get all documents to index.\n\nTo get more info, check out the section about this extension in [my article about elipdotter](https://icelk.dev/articles/search-engine.#kvarn-integration).\n\n\u003e This means this implementation currently does not crawl the local site.\n\nThis extension provides an endpoint which returns the result in JSON format. The scheme is described on [icelk.dev](https://icelk.dev/api/#search).\n\nFor an example of a frontend, check out [this portion of the overview at kvarn.org](https://kvarn.org/search.#frontend).\n\n# Cargo features\n\nEnable the `wordpress-sitemap` feature to automatically index a WordPress site.\nYou also have to set the option `index_wordpress_sitemap` option in `Options` to enable it.\n\n# Versions\n\n-   0.1.x - `kvarn v0.4`\n-   0.2.x - `kvarn v0.4`\n-   0.3.x - `kvarn v0.4`\n-   0.4.x - `kvarn v0.5.x`\n-   0.5.x - `kvarn v0.6.x`\n\n# Changelog\n\n## v0.5.0\n\n-   Support Kvarn v0.6.0\n-   Update elipdotter \u0026 scraper.\n\n## v0.4.0\n\n-   Add hashes `#` to headings in preview (like headings are written in MarkDown)\n-   Ignore Kvarn Chute generated table of content when indexing\n-   Update to `kvarn v0.5.0`\n-   Updated `notify` dependency\n\n## v0.3.2\n\n-   Fixed issue when files has non-alphanumerical characters in them.\n\n## v0.3.1\n\n-   Removed unwanted debugging.\n\n## v0.3.0\n\n-   Updated [elipdotter](https://crates.io/crates/elipdotter)\n    -   See [it's changelog](https://github.com/Icelk/elipdotter#v030) for the comprehensive improvements to search results and performance.\n-   Added option [`kind`](https://doc.icelk.dev/kvarn-search/kvarn_search/struct.Options.html#structfield.kind)\n    to choose the type of index. Using `Simple` takes less memory. Using `Lossless` is 10x faster but uses more memory (2-4x).\n\n## v0.2.0\n\n-   Updated [elipdotter](https://crates.io/crates/elipdotter)\n    -   See [it's changelog](https://github.com/Icelk/elipdotter#v020) for the comprehensive improvements to search results and memory performance.\n-   Added option [`ignore_paths`](https://doc.icelk.dev/kvarn-search/kvarn_search/struct.Options.html#structfield.ignore_paths)\n    to filter out documents from being indexed.\n\n# Development\n\nSince this is used by some projects which require the git version of Kvarn, this requires [Kvarn](https://github.com/Icelk/kvarn) to be cloned at `../kvarn` during development.\n\n# License\n\n`kvarn-search` is licensed under the [GNU LGPLv3](COPYING).\nAll contributions must also be.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficelk%2Fkvarn-search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ficelk%2Fkvarn-search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficelk%2Fkvarn-search/lists"}