{"id":25806732,"url":"https://github.com/sqlitecloud/docsearch-action","last_synced_at":"2025-02-27T20:29:03.733Z","repository":{"id":243682265,"uuid":"811388217","full_name":"sqlitecloud/docsearch-action","owner":"sqlitecloud","description":"SQLite Cloud documents full-text search action.","archived":false,"fork":false,"pushed_at":"2025-02-18T14:18:40.000Z","size":46,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-25T11:50:37.622Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://sqlitecloud.io","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sqlitecloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-06-06T13:56:16.000Z","updated_at":"2025-02-18T14:00:58.000Z","dependencies_parsed_at":"2024-06-17T17:45:35.472Z","dependency_job_id":"417add9a-bce2-45a3-a8de-a2965fd55233","html_url":"https://github.com/sqlitecloud/docsearch-action","commit_stats":null,"previous_names":["sqlitecloud/sqlitecloud-docsearch","sqlitecloud/docsearch-action"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqlitecloud%2Fdocsearch-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqlitecloud%2Fdocsearch-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqlitecloud%2Fdocsearch-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqlitecloud%2Fdocsearch-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sqlitecloud","download_url":"https://codeload.github.com/sqlitecloud/docsearch-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241056738,"owners_count":19901846,"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":"2025-02-27T20:29:03.130Z","updated_at":"2025-02-27T20:29:03.721Z","avatar_url":"https://github.com/sqlitecloud.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SQLite Cloud Documentation Search\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://sqlitecloud.io/social/logo.png\" height=\"300\" alt=\"SQLite Cloud logo\"\u003e\n\u003c/p\u003e\n\n![Build Status](https://github.com/sqlitecloud/docsearch-action/actions/workflows/test.yaml/badge.svg \"Build Status\")\n[![Latest Release](https://img.shields.io/github/v/tag/sqlitecloud/docsearch-action?label=Version)](https://github.com/sqlitecloud/docsearch-action/releases/latest)\n\nThis GitHub Action automates the process of building a table for an out-of-the-box documentation website full-text search powered by SQLite Cloud.\n\n## Features\n\n- Easy setup and configuration\n- Seamless integration with your documentation website\n- Utilizes the power of SQLite Cloud for efficient full-text search\n\n## Usage\n\nTo use this GitHub Action, follow these steps:\n\n1. Create a new workflow file (e.g., `.github/workflows/docsearch.yml`) in your repository.\n2. Add the following code to the workflow file:\n\n```yaml\nname: Documentation Search\n\non:\n    push:\n        branches:\n            - main\n\njobs:\n    build:\n        runs-on: ubuntu-latest\n\n        steps:\n            - name: Checkout repository\n              uses: actions/checkout@v4\n\n            - name: Build SQLite Cloud database\n              uses: sqlitecloud/docsearch-action@v4\n              with:\n                project-string: ${{ secrets.PROJECT_STRING }}\n                base-url: https://your-website.com/docs/\n                path: path/to/your/docs\n                database: my-docs-search\n```\n\n3. Make sure you have a project on SQLite Cloud. If not, sign up for an account and create one.\n4. Add the Project Connection String as a secret in your repository settings, named `PROJECT_STRING`.\n5. Create a database in your SQLite Cloud project and write its name in the `database` input of the action.\n6. Customize these inputs according to your needs.\n      * The `base-url` represents the common part of your documentation URL.\n      * If the `path` input is not specified, the workflow will recursively search for every .md or .mdx file starting from the root folder.\n      * Set the `strip-html` input to `true` if you want to remove HTML elements.\n      * Set the `strip-jsx` input to `true` if you want to remove JSX elements.\n      * Set the `strip-md-titles` input to `true` if you want to remove markdown titles to avoid redundancy in the search.\n      * Set the `use-front-matter` input to `true` if you want to move the front matter to the `documentation` table as a JSON Object.\n      * Set the `path-using-slug` input to `true` if you want to use the slug in the header as the path instead of the relative one for the URL.\n7. Commit and push the workflow file to your repository.\n\n\nNow, whenever you push changes to the `main` branch, the GitHub Action will automatically update the table for your documentation website's full-text search using SQLite Cloud.\n\n# Extra\n\nYou can also use our docbuilder from the `src` folder locally! Just compile it with your preferred compiler (don't forget to link libraries) and run it without any arguments, it will show you instructions on how to use it! By running it locally you can choose between printing sql to a file or building an SQLite  database file.\n\nFor more information and advanced configuration options, please refer to this article [SQLite Cloud Blog](https://blog.sqlitecloud.io/drop-in-docs-search-with-sqlite-cloud).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqlitecloud%2Fdocsearch-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsqlitecloud%2Fdocsearch-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqlitecloud%2Fdocsearch-action/lists"}