Skip to content

Commit 244ac12

Browse files
authored
Update README.md
1 parent 3cd54b0 commit 244ac12

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
uses: actions/checkout@v4
3333

3434
- name: Build SQLite Cloud database
35-
uses: sqlitecloud/sqlitecloud-docsearch@v0.5
35+
uses: sqlitecloud/sqlitecloud-docsearch@v1
3636
with:
3737
project-string: ${{ secrets.PROJECT_STRING }}
3838
path: path/to/your/docs
@@ -41,13 +41,14 @@ jobs:
4141
4242
3. Make sure you have a project on SQLite Cloud. If not, sign up for an account and create one.
4343
4. Add the Project Connection String as a secret in your repository settings, named `PROJECT_STRING`.
44-
5. Customize these inputs according to your needs.
44+
5. Create a database in your SQLite Cloud project and write its name in the `database` input of the action.
45+
6. Customize these inputs according to your needs.
4546
* if the `path` input isn't specified the workflow will search for every .md or .mdx file recursively from the root folder.
4647
* `strip-html`: Set this input to `true` if you want to remove the html elements.
4748
* `strip-jsx`: Set this input to `true` if you want to remove the jsx elements.
4849
* `strip-md-titles`: Set this input to `true` if you want to remove the markdown titles to avoid redundancy in the search.
4950
* `strip-astro-header`: Set this input to `true` if you want to remove the Astro header from every file.
50-
6. Commit and push the workflow file to your repository.
51+
7. Commit and push the workflow file to your repository.
5152

5253

5354
Now, 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.

0 commit comments

Comments
 (0)